Univer — アプリに表計算や文書編集を組み込めるTypeScript製Office SDK
dream-num/univer
★ 24,502 ・ TypeScript ・ Apache-2.0
概要
Univer(ユニバー)は、独自プロダクトやWebアプリケーションの中にOffice製品相当の編集環境を組み込むためのOffice SDKです。業務システムや自社サービスに、表計算(Sheets)やリッチテキストドキュメント(Docs)などの編集機能、計算機能、データ処理機能を直接埋め込む用途に適しています。
近年では人間が操作するUIとしてだけでなく、AIエージェントがプログラム経由でワークブックやドキュメントを読み書きするインターフェースとしても活用できるよう設計されています。エンドユーザー向けのGUIエディタとして画面に配置する利用法に加え、Node.js環境でUIを描画せずにデータ処理や数式計算を実行する「ヘッドレス処理」にも対応している点が特徴です。
本リポジトリで提供されているオープンソース(Apache-2.0ライセンス)の範囲は、Web SDKのコアアーキテクチャ、レンダリングおよび数式エンジン、Facade API、そしてSheets(表計算)とDocs(文書)の主要な編集機能です。専用のOffice製品を立ち上げることなく、Webブラウザ上で自然な操作感の編集環境を構築したいフロントエンドエンジニアやプロダクト開発者に向いています。
主な特徴
- Web SDKを中心としたモジュール構成: コンテンツモデル、描画エンジン、数式計算、Facade APIなどの基底実装がオープンソースとして提供され、必要なプラグインやプリセットを選択してアプリケーションに組み込めます。
- Sheets(表計算)のオープンソース機能群: セル書式、セル結合、セル内リッチテキスト、ウィンドウ枠固定、画像配置、数式、名前付き範囲、フィルタリング、並べ替え、データの入力規則、条件付き書式、ハイパーリンク、コメント、検索と置換など、表計算で頻繁に使われる機能を標準でサポートしています。
- Docs(文書作成)のオープンソース機能群: リッチテキスト編集、段落スタイル設定、箇条書きリスト、ハイパーリンク、コメント、描画オブジェクトとの連携などに対応しています。
- UIを持たないヘッドレス処理: Node.jsなどの環境において、ブラウザエディタを表示することなくコンテンツモデルやコマンド、数式計算エンジンを再利用し、スナップショットの生成や自動データ処理を実行できます。
- Facade APIとイベントによる統合: アプリケーションコードや外部のAIエージェントから安全にコンテンツを読み書きできるよう、抽象化されたFacade APIとライフサイクルイベントが整備されています。
使い方
READMEに記載されているViteなどのバンドラ環境を前提とした、表計算エディタの最小セットアップ手順です。
1. パッケージのインストール
まず、コアプリセットパッケージをインストールします。
pnpm add @univerjs/presets @univerjs/preset-sheets-core
2. コンテナの配置と初期化
HTMLにエディタを表示するDOMコンテナを用意した上で、TypeScript側で初期化コードを実行します。
import { UniverSheetsCorePreset } from '@univerjs/preset-sheets-core'
import UniverPresetSheetsCoreEnUS from '@univerjs/preset-sheets-core/locales/en-US'
import { createUniver, LocaleType, mergeLocales } from '@univerjs/presets'
import '@univerjs/preset-sheets-core/lib/index.css'
const { univerAPI } = createUniver({
locale: LocaleType.EN_US,
locales: {
[LocaleType.EN_US]: mergeLocales(UniverPresetSheetsCoreEnUS),
},
presets: [
UniverSheetsCorePreset({
container: 'app',
}),
],
})
univerAPI.createWorkbook({})
これでページ上に表計算エディタが表示され、初期化時に返される univerAPI 経由でシートの操作が可能になります。
3. アプリケーションコードからのデータ操作
作成したワークブックに対してデータを投入したり、計算結果を取得したりする場合は、ライフサイクルが安定状態(Steady)に達するのを待機してから Facade API を呼び出します。
// 数式コントローラーの準備が整うまで待機
await new Promise<void>((resolve) => {
if (univerAPI.getCurrentLifecycleStage() >= univerAPI.Enum.LifecycleStages.Steady) {
resolve()
return
}
const listener = univerAPI.addEvent(univerAPI.Event.LifeCycleChanged, ({ stage }) => {
if (stage === univerAPI.Enum.LifecycleStages.Steady) {
listener.dispose()
resolve()
}
})
})
const workbook = univerAPI.getActiveWorkbook()!
const sheet = workbook.getActiveSheet()
// 範囲を指定して値を投入する例
sheet.getRange('A1:D4').setValues([
['Item', 'Quantity', 'Unit price', 'Total'],
// ...
])
ReactやVueなどのコンポーネント指向フレームワークで利用する場合は、コンポーネントのアンマウント時に univer.dispose() を呼び出してリソースを解放する必要があります。
技術的なポイント
プラグインアーキテクチャと依存性注入(DI)
Univerは拡張性を重視した設計になっており、各機能が独立したプラグインとして構成されています。内部には依存性注入(DI)の仕組みが備わっており、UI部品、計算エンジン、データモデルなどの責務が分離されています。開発者は既存のプラグインプリセット(preset-sheets-core など)を利用するだけでなく、プラグイン単位で機能を取捨選択したり、自作のプラグインを注入したりできます。
複数機能にまたがるコマンドシステムとUndo/Redo
表計算では、1つの操作が複数の機能に影響を及ぼすことがあります。たとえば、フィルタが設定された範囲内に行を挿入した場合、セルのデータ行が増加するだけでなく、フィルタが対象とする範囲の再定義も必要になります。さらに、Undo(元に戻す)操作を行った際には、その双方の変更を整合性を保ちながら元の状態に戻さなければなりません。Univerのコマンドシステムは、各機能が自身に属する変更差分とUndo用データを個別に提供し、コマンド層でそれらの実行と変更履歴を合成管理できるように設計されています。
Facade API による抽象化
内部の細かなデータ構造やコマンドシステムを直接意識しなくても、外部アプリケーションやAIエージェントから直感的に操作できるように「Facade API」が用意されています。ワークブック、シート、セル範囲(Range)に対する読み書きやイベントリスナーの登録がシンプルなインターフェースとしてカプセル化されているため、UIを持たないバッチ処理や自動化スクリプトとの連携も容易です。
注意点
ライセンスと提供範囲の違い
このGitHubリポジトリで提供されているコードは Apache-2.0 ライセンスのオープンソースですが、すべての関連機能がオープンソースで提供されているわけではありません。READMEによると、Univer Office SDK には以下の住み分けが存在します。
- オープンソース(本リポジトリ): Web SDKのコアアーキテクチャ、コンテンツモデル、レンダリングおよび数式エンジン、Facade API、SheetsおよびDocsの基本編集機能。
- 別配布・商用ライセンス: 商用向けWeb SDKプラグイン、リアルタイム共同編集やファイル入出力を担う「Server SDK」、高度な「AI SDK」拡張などは別パッケージとして配布・管理されています。
本リポジトリ単体でもエディタの埋め込みや基本操作は可能ですが、高度な共同編集サーバーや特定の商用ファイル形式変換を求める場合はライセンス条件を確認する必要があります。
パッケージ間のバージョン整合性
Univerは @univerjs/* というスコープ付きパッケージで分割提供されています。READMEでは、協調して動作させる関連パッケージ間でバージョン番号を統一することが強く推奨されています。バージョンの不一致があると、意図しない不具合や型定義の衝突を招く可能性があるため、依存関係の更新時には注意が必要です。
まとめ
Univerは、Webアプリケーション内に本格的なOffice編集・計算基盤を構築できるTypeScript製SDKです。プラグイン境界やコマンドシステムが整理されたオープンソースのコアエンジンを備えており、ブラウザ上の埋め込みUIからNode.jsでのヘッドレス処理まで幅広い用途に対応します。自社サービスに表計算や文書編集を統合したい開発者にとって、有力な選択肢の1つとなるライブラリです。





