dream-num/univer

来源：https://github.com/dream-num/univer
AI 智能体的办公集成工具套件
电子表格 · 文档 · 演示文稿 · 数据库 · 看板 · PDF（即将推出）
高性能、完全可定制的办公软件开发工具包
通过插件架构、基于 Canvas 的渲染、公式引擎以及一个可在浏览器和 Node.js 上运行的 Facade API，构建可嵌入的高效生产力体验。
English | 简体中文 | 繁體中文 | 日本語 | 한국어 | Español

🌐 官网 (https://univer.ai/) | 📖 文档 (https://docs.univer.ai) | ✨ 案例展示 (https://docs.univer.ai/showcase) | 📘 API 参考 (https://docs.univer.ai/reference/classes/univer) | 📝 博客 (https://docs.univer.ai/blog)
发布版本
许可证
构建状态
代码质量
代码覆盖率
星标数
贡献者
问题追踪
最近提交
Discord
Twitter
Open Collective
Trendshift

✨ 什么是 Univer？

Univer 是一个用于在您自己的产品内创建办公应用程序的开源 SDK。它为您提供构建电子表格、文档和演示文稿体验的基础模块，而无需强制使用托管应用或固定界面。

当您需要执行以下操作时，请使用 Univer：

• 将电子表格或文档编辑功能嵌入 SaaS 产品、内部工具、BI 工作流或 AI 应用程序。
• 在服务器上运行与浏览器中使用相同架构的工作簿/文档处理。
• 通过插件仅组合您需要的功能，或使用预设快速启动。
• 通过自定义插件、命令、服务、UI 组件和 Facade API 扩展行为。

Univer 不仅仅是一个电子表格文件查看器。它是用于构建您自己的高效生产力界面的框架。

在 Univer 产品家族 (https://univer.ai/) 中，办公工具共享用于存储和计算的运行时。内容可以跨工具组合和嵌入，其中关联的数据和引用会同步更新。人员和 AI 智能体可以在同一文件中协同工作。

请参阅功能矩阵 (https://univer.ai/capabilities) 了解产品覆盖范围，并参阅开源版与专业版了解此代码仓库的范围。

基于 Univer Office SDK 构建

以下开源项目使用 Univer Office SDK 构建：

每个项目都记录了其自身的设置和 SDK 许可要求。

🌟 亮点

⚡ 为大型界面构建
基于 Canvas 的渲染和专用公式引擎使复杂工作簿保持响应。

🧩 默认插件化架构
无需依赖整个技术栈即可组合、替换、懒加载或扩展功能。

🤖 适用于 AI 基础设施的无头模式
在 Node.js 中运行工作簿和文档逻辑，为智能体、自动化和服务器端工作流提供支持。

🛠️ 产品就绪的 SDK
框架适配器、Facade API、预设和无头运行时适用于实际集成路径。

🌗 暗黑模式就绪
UI 组件和渲染引擎均能适应浅色和深色主题。

🔌 统一的 Facade API
一个一致的 API 接口，涵盖浏览器和 Node.js 上的工作簿、范围、公式和文档。

🚀 为什么选择 Univer？

• 同构设计：在浏览器中运行 UI 应用程序，在 Node.js 中运行无头处理。
• 插件优先架构：每个功能都作为可组合的插件交付，因此功能可以添加、移除、替换或懒加载。
• 用于快速集成的预设模式：当您需要快速获得一个可运行的应用程序时，请使用 presets/ 中精选的插件集合。
• 用于完全控制的插件模式：当您需要自定义加载、更小的包体积或深度集成时，请手动组合包。
• Facade API：通过更高级别的 API 处理工作簿、工作表、范围、文档、公式、命令和事件。
• Canvas 渲染引擎：通过跨文档类型共享的渲染层，支持大型可编辑文档界面。
• 可扩展的 UI：可与 React、Vue、Web Components 和特定于框架的应用程序外壳集成。

🤖 AI 智能体的办公工作流

Univer 的 AI 和协作功能将智能体的操作与交互式编辑和人工审阅连接起来：

• 程序化编辑：智能体通过结构化 API 检查和修改办公内容。
• 输出验证：智能体通过内容检查、渲染截图和布局诊断来检查结果。
• 工作树协作：智能体在隔离的草稿中工作，然后人员审阅其更改并决定合并哪些内容。

有关集成详情，请参阅 AI SDK 文档 (https://docs.univer.ai/ai)。

实时编辑、共享修订和工作树工作流需要相应的 Web SDK 和协作功能；包的可用性和许可因功能而异。

⚡ 快速开始

插件模式可提供完整的产品覆盖和精确的组合。对于支持的 Sheets、Docs 和 Node 配置文件，预设模式提供了更简短的精选设置。

插件模式

插件模式让您对包、样式导入、区域设置合并、Facade API 注册和插件配置有更底层的控制。

pnpm add @univerjs/core @univerjs/design @univerjs/docs @univerjs/docs-ui @univerjs/engine-formula @univerjs/engine-render @univerjs/sheets @univerjs/sheets-formula @univerjs/sheets-formula-ui @univerjs/sheets-numfmt @univerjs/sheets-numfmt-ui @univerjs/sheets-ui @univerjs/ui

import { LocaleType, mergeLocales, Univer } from '@univerjs/core'
import { FUniver } from '@univerjs/core/facade'
import DesignEnUS from '@univerjs/design/locale/en-US'
import { UniverDocsPlugin } from '@univerjs/docs'
import { UniverDocsUIPlugin } from '@univerjs/docs-ui'
import DocsUIEnUS from '@univerjs/docs-ui/locale/en-US'
import { UniverFormulaEnginePlugin } from '@univerjs/engine-formula'
import { UniverRenderEnginePlugin } from '@univerjs/engine-render'
import { UniverSheetsPlugin } from '@univerjs/sheets'
import SheetsEnUS from '@univerjs/sheets/locale/en-US'
import { UniverSheetsFormulaPlugin } from '@univerjs/sheets-formula'
import SheetsFormulaEnUS from '@univerjs/sheets-formula/locale/en-US'
import { UniverSheetsFormulaUIPlugin } from '@univerjs/sheets-formula-ui'
import SheetsFormulaUIEnUS from '@univerjs/sheets-formula-ui/locale/en-US'
import { UniverSheetsNumfmtPlugin } from '@univerjs/sheets-numfmt'
import { UniverSheetsNumfmtUIPlugin } from '@univerjs/sheets-numfmt-ui'
import SheetsNumfmtUIEnUS from '@univerjs/sheets-numfmt-ui/locale/en-US'
import { UniverSheetsUIPlugin } from '@univerjs/sheets-ui'
import SheetsUIEnUS from '@univerjs/sheets-ui/locale/en-US'
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/docs-ui/lib/index.css'
import '@univerjs/sheets-ui/lib/index.css'
import '@univerjs/sheets-formula-ui/lib/index.css'
import '@univerjs/sheets-numfmt-ui/lib/index.css'

import '@univerjs/engine-formula/facade'
import '@univerjs/ui/facade'
import '@univerjs/sheets/facade'
import '@univerjs/sheets-ui/facade'
import '@univerjs/sheets-formula/facade'
import '@univerjs/sheets-numfmt/facade'

const univer = new Univer({
  locale: LocaleType.EN_US,
  locales: {
    [LocaleType.EN_US]: mergeLocales(
      DesignEnUS,
      UIEnUS,
      DocsUIEnUS,
      SheetsEnUS,
      SheetsUIEnUS,
      SheetsFormulaEnUS,
      SheetsFormulaUIEnUS,
      SheetsNumfmtUIEnUS,
    ),
  },
})

univer.registerPlugin(UniverRenderEnginePlugin)
univer.registerPlugin(UniverFormulaEnginePlugin)
univer.registerPlugin(UniverUIPlugin, { container: 'app' })
univer.registerPlugin(UniverDocsPlugin)
univer.registerPlugin(UniverDocsUIPlugin)
univer.registerPlugin(UniverSheetsPlugin)
univer.registerPlugin(UniverSheetsUIPlugin)
univer.registerPlugin(UniverSheetsFormulaPlugin)
univer.registerPlugin(UniverSheetsFormulaUIPlugin)
univer.registerPlugin(UniverSheetsNumfmtPlugin)
univer.registerPlugin(UniverSheetsNumfmtUIPlugin)

const univerAPI = FUniver.newAPI(univer)

univerAPI.createWorkbook({})

预设模式

预设是精选的 Univer 插件集合，包含必要的 Facade API 注册和样式。

pnpm add @univerjs/presets @univerjs/preset-sheets-core

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({})

您的页面需要一个容器：

<div id="app"></div>

在安装和基本使用指南、createUniver 参考和 Facade API 参考中了解更多内容。

🧩 预设模式 vs 插件模式

请将 @univerjs/* SDK 包保持在同一个协调的 Univer 发布线上，使用相同版本。独立发布的包，包括 @univerjs/icons 和 @univerjs/icons-svg，则使用包清单中声明的兼容版本，而非 SDK 版本。

如果您使用 Univer Pro 包，请将 @univerjs-pro/* 与匹配的协调发布线对齐。

有关 API 兼容性预期、实验性 API、内部 API 和弃用规则，请参阅 API 稳定性策略。

🧭 兼容性

• 浏览器运行时：Univer 使用 Chrome 88 目标进行编译，旨在支持 Edge >=88、Firefox >=90、Chrome >=88、Safari >=14.1 和 Electron >=12。
• Polyfills：Univer 依赖于 Intl.Segmenter。如果您的目标浏览器或运行时未提供它，请添加一个 polyfill，例如 @formatjs/intl-segmenter。
• 构建工具：我们推荐使用 Vite、esbuild 或 Webpack 5。如果您的构建工具不支持 package.json 中的 exports 字段（在 Webpack 4 中常见），您可能需要额外的路径映射。
• React：Univer 的视图层基于 React 18 构建，支持 React 18 和 19，并为 React 16.9+ 和 17 提供最低限度的兼容支持。
• Node.js 运行时：无头 Univer 支持 Node.js >=18.17.0。开发此 monorepo 需要 Node.js >=22.18。

🛠️ 您可以构建什么

Sheets 是当今最成熟的产品界面。Docs 和 Slides 共享 Univer 的架构，并在同一 SDK 中持续发展。

🔓 开源版与专业版

此代码仓库包含 Univer 的开源核心和第一方 OSS 插件。Univer Pro 作为商业扩展层单独开发，用于高级产品界面、协作、服务器功能和企业集成。