Skip to content

Build your own AI office with Univer Office SDK. Bring editing, calculation, collaboration, and file processing into your product for people and AI agents. Built on an extensible open-source core.

1.9 KB
Raw Blame

@univerjs/sheets

npm version license downloads

@univerjs/sheets provides the core spreadsheet data model and business logic for Univer Sheets, independent of the UI layer.

Package Overview

Package UMD global CSS Locales Facade entry Worker entry
@univerjs/sheets UniverSheets No Yes Yes Yes

Installation

pnpm add @univerjs/sheets
# or
npm install @univerjs/sheets

Usage

Start with the integration setup for your document type, including its required plugins, styles, and locale resources. The snippet below assumes that setup is complete.

import EnUS from '@univerjs/sheets/locale/en-US';
import { UniverSheetsPlugin } from '@univerjs/sheets';

univer.registerPlugin(UniverSheetsPlugin);

// Merge EnUS into your Univer locale map when this package contributes UI text.

Worker usage

On the main thread, import UniverSheetsPlugin from @univerjs/sheets. Set notExecuteFormula: true to delegate calculation to the worker.

In the worker entry, import UniverSheetsPlugin from @univerjs/sheets/worker:

import { UniverSheetsPlugin } from '@univerjs/sheets/worker';

univer.registerPlugin(UniverSheetsPlugin, { onlyRegisterFormulaRelatedMutations: true });

Integration Notes

  • Import @univerjs/sheets/facade when using this package through Univer Facade APIs.

Resources