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.
TypeScript boardcollaborationdocdocxexceloffce365officepdfpptpptxpresentationsdksheetslidesspreadsheetuniverwordwordprocessorworkspacexlsx
@univerjs/sheets-note
@univerjs/sheets-note adds the core note model and commands for cell notes in Univer Sheets.
Package Overview
| Package | UMD global | CSS | Locales | Facade entry | Worker entry |
|---|---|---|---|---|---|
@univerjs/sheets-note |
UniverSheetsNote |
No | No | Yes | No |
Installation
pnpm add @univerjs/sheets-note
# or
npm install @univerjs/sheets-note
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 { UniverSheetsNotePlugin } from '@univerjs/sheets-note';
univer.registerPlugin(UniverSheetsNotePlugin);
Integration Notes
Use this package with @univerjs/sheets-note-ui when users need note editing UI.
- Import
@univerjs/sheets-note/facadewhen using this package through Univer Facade APIs.