@univerjs/sheets-table adds the core table model and commands for binding structured table data in Univer Sheets.
| Package | UMD global | CSS | Locales | Facade entry | Worker entry |
|---|---|---|---|---|---|
@univerjs/sheets-table |
UniverSheetsTable |
No | Yes | Yes | Yes |
pnpm add @univerjs/sheets-table
# or
npm install @univerjs/sheets-tableStart 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 { LocaleType, mergeLocales, Univer } from '@univerjs/core';
import { UniverSheetsTablePlugin } from '@univerjs/sheets-table';
import EnUS from '@univerjs/sheets-table/locale/en-US';
const univer = new Univer({
locale: LocaleType.EN_US,
locales: {
[LocaleType.EN_US]: mergeLocales(EnUS),
},
});
univer.registerPlugin(UniverSheetsTablePlugin);On the main thread, import UniverSheetsTablePlugin from @univerjs/sheets-table.
In the worker entry, import UniverSheetsTablePlugin from @univerjs/sheets-table/worker:
import { UniverSheetsTablePlugin } from '@univerjs/sheets-table/worker';
univer.registerPlugin(UniverSheetsTablePlugin);Use this package with @univerjs/sheets-table-ui when users need table controls in the sheet UI.
- Import
@univerjs/sheets-table/facadewhen using this package through Univer Facade APIs.