Univer
Univer is an Office SDK for embedding editing, calculation, collaboration, and file processing into products for people and AI agents, built on an extensible open-source core.
Visit dream-num/univerOverview
Univer is an Office SDK for building Office applications inside a product, with Web, Server, and AI SDK parts for editing, calculation, collaboration, file processing, and agent workflows. This repository provides the open-source Web SDK core architecture and engine implementations, including Sheets and Docs editing.
Key Features
- Composable Web SDK core with content models, editing, rendering, formula calculation, and Facade APIs.
- Open-source Sheets editing and layout, including cell styles, merged cells, in-cell rich text, freeze panes, floating images, and undo/redo.
- Sheets data and calculation features, including formulas, defined names, filtering, sorting, data validation, conditional formatting, hyperlinks, comments, and find and replace.
- Docs rich-text editing with paragraph formatting, lists, hyperlinks, comments, and drawing integration.
- Plugin architecture with feature and UI separation, dependency injection, command, mutation, and operation actions, and composed undo/redo.
- Headless processing in Node.js using content plugins, models, commands, and calculation without an interactive editor.
Use Cases
- Embed an editable spreadsheet or document surface in an application or agent product.
- Process Office content without an editor using Node.js for editing, snapshots, and automated tasks.
- Develop custom features or editors by reusing engines, UI components, plugin boundaries, dependency injection, and command and undo systems.
- Connect application code or agents to workbook data through Facade APIs for tasks such as updating values and reading recalculated totals.
Getting Started
- Install the presets and Sheets Core preset packages with pnpm: pnpm add @univerjs/presets @univerjs/preset-sheets-core.
- Create a container element in the page before initializing Univer.
- Initialize createUniver with the Sheets Core preset, locale settings, and the container id, then call univerAPI.createWorkbook.
- Use the returned univerAPI to work with workbook content; in component frameworks, dispose the Univer instance on unmount.
Deployment & Requirements
- Use a browser application with a bundler such as Vite for the quick-start editor.
- Use Node.js for headless processing workflows.
- Keep coordinated UniverJS packages on the same version; commercial packages must use the matching release line.
Before You Adopt
- License: Apache-2.0. Review its terms before using, modifying, or distributing the project.
- Some Web SDK plugins, the Server SDK, and commercial AI SDK extensions are distributed and licensed separately from the open-source repository.
- Snapshot persistence does not include XLSX import and export; those rely on separately distributed file-conversion capabilities.
- Applications are responsible for persisting snapshots; the provided example uses browser storage.