Univer: embed a spreadsheet and document editor in your own app
dream-num/univer is a TypeScript SDK that embeds a spreadsheet and document editor in your own web product, with the same content models for browser editing, headless Node.js work, and agent-driven edits.
dream-num/univer lets you put a working spreadsheet editor, and a document editor, inside your own web product, so your users can edit cells, write text, and run calculations without leaving your application. It is a software kit for developers, not a separate office program you download and open on its own. Your code creates the editor, fills it with data, reads the result back, and decides where that data is stored. The same content can also be changed by an agent working through code, which makes the kit useful for products where people and automated helpers share the same workbook.
The open-source part of the project covers the spreadsheet and document editors, the calculation engine, and the rendering engine. Extra content types, collaboration, file conversion, and some agent tooling sit in separate commercial parts, so check which side of that line a feature falls on before you plan around it.
Quick facts
- Free open-source core under the Apache-2.0 licence, written in TypeScript.
- More than 27,000 GitHub stars and about 2,500 forks as of November 16, 2026, with 93 open issues and 84 open pull requests. The repository was created on September 29, 2022.
- Latest release v1.5.2, published on November 16, 2026, hours after v1.5.1; the notes for both only link the changelog. The last release with full notes is v1.5.0, from November 14, 2026.
- Runs in the browser and in Node.js without a visible editor. Supported browsers are Edge 88 or newer, Firefox 90 or newer, Chrome 88 or newer, Safari 14.1 or newer, and Electron 12 or newer.
- Headless use in Node.js needs Node.js 18.17.0 or newer. Developing the repository itself needs Node.js 22.18 or newer and the pnpm version pinned in its package.json, currently pnpm 12.16.1; the contributing guide gives pnpm 11 as the minimum.
- The view layer is built on React 18 and supports React 18 and 19, with minimal compatibility support for React 16.9 or newer and React 17.
- Commercial extensions are licensed separately. Trying the paid parts without paying adds visible marks and turns some features off.
Version 1.5.0 reduces memory use during formula calculation. Its headline additions, chart sheets, stacked line charts, and error bars, are not part of the open-source install: they need the Sheets Chart Facade, the README lists charts among the commercial Web SDK plugins, and this repository has no chart package. Before upgrading, read the release notes for every version between yours and the target, as the project asks.
How to install
In a browser application that uses a bundler such as Vite, run this in your project folder. The quick start needs two packages: the shared preset package and the Sheets Core preset.
pnpm add @univerjs/presets @univerjs/preset-sheets-coreIf the command ends with an error, check before assuming it failed. On November 16, 2026, in an empty project with pnpm 12.16.1, the version this repository pins, pnpm added both packages to package.json and node_modules, then exited with ERR_PNPM_IGNORED_BUILDS because it had skipped the install script of protobufjs 7.6.6, which arrives through @univerjs/protocol. The error's help text points to pnpm approve-builds, where you decide whether that script may run.
The contributing guide also lists pnpm create @univerjs/cli init <project-name>, but that sits under its New Package heading and does not scaffold an application. The published @univerjs/create-cli 0.6.5 has no init command; it opens an interactive prompt whose only choice is to create a new Univer plugin.
Keep the @univerjs packages that are released together, including presets and their plugins, on the same exact version. Independently versioned packages such as @univerjs/icons follow the versions declared in package manifests instead; the UI package currently pins icons 1.47.0. Mixing SDK versions can break plugin registration, the application-facing APIs, commands, locales, and the shared data models, so check what actually resolved in your lockfile: in the same test, pnpm resolved 1.5.0 for both packages although npm already listed 1.5.2 as latest.
First setup
Put a container element with the identifier app and a full-height style on your page, then initialize the editor from your application code. The quick start imports the Sheets Core preset, its English locale and its CSS, creates the editor with createUniver, and opens a blank workbook:
<div id="app" style="height: 100vh"></div>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({})The quick start needs no paid licence, server package, account, or key. createUniver also returns the underlying univer instance; in a component framework, keep it and call univer.dispose() when the component unmounts. Do not dispose the workbook that createWorkbook returns instead: that only releases its facade, and the source comment says units are unloaded with univerAPI.disposeUnit(). Before editing a new workbook, wait for the Steady lifecycle stage so the formula controllers are ready, as the repository's worked example does.
To save, call the save method on the workbook. It returns a JSON snapshot that holds the workbook and the data registered by its plugins, and your application owns where that snapshot goes. The worked example stores it in the browser, then loads it back on a later visit instead of creating a blank workbook.
What stands out
- One set of content models serves both the visible editor and headless Node.js work. Content is stored as serializable snapshots, so a browser editor, a backend service, and an agent can all work from the same shape of data instead of separate formats. The open-source packages cover workbooks and documents; snapshot types for slide decks and canvas boards exist, but current Slides and Boards capabilities are separately distributed commercial products.
- Edits go through commands that carry their own change and undo data, and the system composes those pieces when one action touches several features. Inserting a row inside a filtered range changes both the cells and the filter range, and one undo restores both.
- The formula engine recalculates automatically when a value changes. The worked example fills a small quotation, changes a quantity from 2 to 4, and reads back a total of 200 from the same workbook the editor shows.
- Features are assembled from plugins, and presets bundle a useful set of them for you. The Sheets Core preset is the short path, while the manual plugin mode lets you pick plugins, dependencies, and loading order yourself when you need precise control.
- Agent tooling is built on the same interfaces as the visible editor. Inspection returns structured content, a render runtime can take screenshots to check what the result actually looks like, and a draft workflow lets an agent edit an isolated copy over several rounds before a person reviews, merges, or reopens it. Those agent and collaboration capabilities are part of the wider commercial offering, not the open-source core.
Try it with your AI. Paste this into your own AI assistant to set up the same open-source spreadsheet editor in your project, using only the commands and interfaces checked for this article.
Help me add an editable spreadsheet to my existing web application using
dream-num/univer, open-source packages only. First check my setup and tell me what does
not match: my bundler (the project recommends Vite, esbuild, or Webpack 5), my React
version (React 18 or 19; React 16.9+ and 17 get only minimal compatibility support),
whether my target browsers provide Intl.Segmenter, and my pnpm version. Do not continue
until I confirm.
Then install with `pnpm add @univerjs/presets @univerjs/preset-sheets-core`. If pnpm
exits with ERR_PNPM_IGNORED_BUILDS for protobufjs, stop, show me the message and the
versions in package.json and the lockfile, and let me decide about `pnpm
approve-builds`. Keep both packages on the same exact version; do not force
independently versioned packages such as `@univerjs/icons` to match it.
Add `<div id="app" style="height: 100vh"></div>` and, in [the file where my app starts],
the README quick start: import `UniverSheetsCorePreset`, the en-US locale from
`@univerjs/preset-sheets-core/locales/en-US`, `createUniver`, `LocaleType` and
`mergeLocales` from `@univerjs/presets`, and
`@univerjs/preset-sheets-core/lib/index.css`; call `createUniver` with `locale:
LocaleType.EN_US`, the merged locale and `UniverSheetsCorePreset({ container: 'app' })`;
then call `univerAPI.createWorkbook({})`. Keep the returned `univer` and call
`univer.dispose()` when [my component] unmounts.
Next, reproduce the quotation example: wait for the Steady lifecycle stage, write the
four rows with `setValues`, change B2 to 4 with `setValue`, wait for
`univerAPI.getFormula().onCalculationResultApplied()`, and check that D4 reads 200. Save
with `workbook.save()` and, on a later load, restore that JSON snapshot with
`univerAPI.createWorkbook(...)` instead of creating a blank workbook.
Show me any risky step first and wait for my confirmation before running it. Do not
install anything from unknown sources, do not touch credential files, and do not delete
anything.Known limits
- The demos show the wider commercial SDK, including Slides and Boards, which ship as paid add-ons rather than in this repository, so do not assume the demo set is what you get from the open-source packages.
- Turning a workbook into an XLSX, DOCX, or PPTX file, or reading one of those files in, relies on conversion code that ships separately. Saving a JSON snapshot is not the same as exporting a spreadsheet file.
- SECURITY.md lists only the latest version as supported for security updates and warns that unsupported versions may contain unpatched vulnerabilities; the API stability policy adds that a major version leaving active maintenance still gets security updates for one year. The same file still says Univer has not reached version 1.0, although v1.0.0 was released on September 24, 2026. Report a suspected vulnerability privately by email to [email protected], and do not post its details in a public issue, forum, or social media post until a fix is released.
- The most recent prerelease, v0.8.0-beta.0, dates from May 26, 2025. Prerelease builds are for testing upcoming changes, so validate one separately before adopting it in production. APIs marked experimental, alpha, beta, or preview can change name, signature, behaviour, or location, or be removed, and internal APIs carry no compatibility promise at all.
- Some browsers and runtimes lack Intl.Segmenter; in that case add a polyfill, for example the @formatjs/intl-segmenter package. Build tools that do not support the exports field in package.json, which the project notes is common with Webpack 4, may need extra path mapping.
- Your application owns persistence, identity, permissions, storage, and, for agent use, the model and its orchestration; the kit supplies the editing surface and the interfaces, not those.
Related on claudefox
- AG-UI: connect an AI agent to a frontend app with a shared event protocol
- Claude gets Whiteboards, Sheets and Data
- Microsoft shares slide after the Claude Sheets launch
- stack-diagram: an unofficial agent skill that turns one sentence into an architecture diagram with official logo files
Problems and feedback
Report bugs in the repository issue tracker, where the project provides bug and feature templates, and ask questions in GitHub Discussions or on the project Discord server. Security reports go to [email protected] instead of the public tracker, and the contributing guide points new contributors to the issue templates and the code of conduct before they open a pull request.
Source: dream-num/univer repository, dream-num/univer releases, dream-num/univer v1.5.0 release notes, dream-num/univer README, dream-num/univer LICENSE, dream-num/univer SECURITY.md, dream-num/univer CONTRIBUTING.md, dream-num/univer API Stability Policy, dream-num/univer issues, dream-num/univer discussions, Univer documentation, @univerjs/create-cli on npm
This story first appeared in the claudefox daily briefing for November 16, 2026.