Web SDK

安裝與基本使用

本章介紹 Univer Bases 的安裝方式與基本用法。Bases 以 Univer Office SDK 產品的形式發佈，目前採用外掛模式。

如果你還不熟悉 Univer 的核心概念，請先閱讀快速入門。

Univer 提供預設模式與外掛模式兩種整合方式。預設模式透過預先組合好的外掛簡化設定，更容易上手；如果需要深度擴充，建議使用外掛模式，依需求組合與設定外掛。

透過外掛模式建立

瀏覽器中的 Bases 應用程式通常會先註冊共用的 Univer 執行環境、算繪引擎、UI 殼層、公式引擎與 授權，接著再註冊 Bases 模型與 UI 外掛。

使用套件管理器

使用支援 ES Module 和 package.json 中 exports 欄位的建置工具。

安裝

Univer 使用 React 建構介面、RxJS 處理資料流，也可以嵌入 Vue 或 Angular 應用程式。請確認已安裝 react、react-dom 和 rxjs 這些 peer dependencies1；下方 Yarn 指令已明確包含它們。

所有 @univerjs/* 和 @univerjs-pro/* 套件應保持相同版本。

Shell
pnpm add @univerjs/core @univerjs/design @univerjs/engine-render @univerjs/ui @univerjs-pro/bases @univerjs-pro/bases-ui @univerjs-pro/engine-formula @univerjs-pro/license

使用

初始化 Univer 前，先建立容器並設定明確的高度：

HTML
<div id="app" style="height: 600px"></div>

呼叫 FUniver.newAPI(univer) 前，請引入下方範例使用的 facade 入口。樣式依 @univerjs/design、@univerjs/ui、產品 CSS 的順序引入。

注意

  • 請先註冊 UniverLicensePlugin，再註冊 Bases 外掛。
  • 請先匯入共用 UI CSS，再匯入產品 UI CSS。
  • Bases（包括儀表板形狀）使用 @univerjs-pro/engine-formula 中的 UniverProFormulaEnginePlugin。在同一個 Univer 執行個體中組合多個產品時，請替換既有的 UniverFormulaEnginePlugin 匯入與註冊，請勿同時註冊兩個公式引擎。

  1. 匯入樣式、語系套件與必要的外掛：

    TypeScript
    import { UniverBasesPlugin } from '@univerjs-pro/bases'import { UniverBasesUIPlugin } from '@univerjs-pro/bases-ui'import BasesUIEnUS from '@univerjs-pro/bases-ui/locale/en-US'import BasesEnUS from '@univerjs-pro/bases/locale/en-US'import { UniverProFormulaEnginePlugin } from '@univerjs-pro/engine-formula'import { UniverLicensePlugin } from '@univerjs-pro/license'import { LocaleType, mergeLocales, Univer, UniverInstanceType } from '@univerjs/core'import DesignEnUS from '@univerjs/design/locale/en-US'import { UniverRenderEnginePlugin } from '@univerjs/engine-render'import { UniverUIPlugin } from '@univerjs/ui'import UIEnUS from '@univerjs/ui/locale/en-US'import '@univerjs/design/lib/index.css'import '@univerjs/ui/lib/index.css'import '@univerjs-pro/bases-ui/lib/index.css'

  2. 如要使用 Facade API2，請匯入 Facade 進入點：

    TypeScript
    import { FUniver } from '@univerjs/core/facade'import '@univerjs-pro/bases/facade'import '@univerjs-pro/bases-ui/facade'

  3. 建立 Univer 執行個體、註冊外掛，並建立 Base 單元：

    TypeScript
    const univer = new Univer({  locale: LocaleType.EN_US,  locales: {    [LocaleType.EN_US]: mergeLocales(      DesignEnUS,      UIEnUS,      BasesEnUS,      BasesUIEnUS,    ),  },})univer.registerPlugin(UniverRenderEnginePlugin)univer.registerPlugin(UniverUIPlugin, { container: 'app' })univer.registerPlugin(UniverProFormulaEnginePlugin)univer.registerPlugin(UniverLicensePlugin, {  license: process.env.CLIENT_LICENSE_TEXT,})univer.registerPlugin(UniverBasesPlugin)univer.registerPlugin(UniverBasesUIPlugin)univer.createUnit(UniverInstanceType.UNIVER_BASE, {})const univerAPI = FUniver.newAPI(univer)

univer.registerPlugin 與 univer.registerPlugins 方法

univer.registerPlugin 用於將外掛註冊到 Univer 實例。可於建立實例後呼叫。

使用方式：univer.registerPlugin(Plugin, options)，其中 Plugin 為外掛類別，options 為該外掛的（可選）設定。

亦可透過 univer.registerPlugins 傳入陣列，一次性註冊多個外掛，便於集中管理：

TypeScript
univer.registerPlugins([  UniverRenderEnginePlugin,  [UniverUIPlugin, { container: 'app' }],  UniverProFormulaEnginePlugin,  [UniverLicensePlugin, {    license: process.env.CLIENT_LICENSE_TEXT,  }],  UniverBasesPlugin,  UniverBasesUIPlugin,])

行動裝置支援

目前 @univerjs-pro/bases-ui 沒有匯出獨立的行動版 UI 外掛。請勿使用不存在的 MobileUIPlugin 匯入或 mobile: true 選項。縮窄容器不代表已完整支援觸控互動，請在目標裝置上驗證既有 UI。

其他發佈版本

除穩定版外，Univer 亦提供 alpha / beta 通道。這些版本可讓你搶先體驗未正式釋出的新功能；但請注意，功能更多同時代表風險更高，可能包含錯誤、未完成或不穩定特性。生產環境請謹慎使用。

Alpha / Beta 版本

當團隊完成新功能或重大調整，可能會預先發佈於 alpha 或 beta 通道。可用以下指令安裝：

Shell
pnpm add @univerjs-pro/bases@alpha # Alpha 版本
pnpm add @univerjs-pro/bases@beta # Beta 版本

若於使用 alpha / beta 過程遇到問題或有建議，歡迎透過 GitHub Issues 回報。

祝你搶先體驗愉快！

下一步

Footnotes

  1. peerDependencies 表示需要由宿主專案提供相容版本的相依套件，讓 Univer 與應用程式共用 React 等函式庫，而不是各自攜帶一份。 ↩

  2. Facade 是面向應用程式的 API，封裝已註冊外掛的能力。匯入 Facade 入口會擴充 API 方法，但不會取代功能外掛的註冊。 ↩

你覺得這篇文檔如何？

© 2026 DreamNum Co., Ltd.