bcf6ef63ad
Some checks failed
📦 Build / build (push) Has been cancelled
🧪 CI Test / test shard (1/4) (push) Has been cancelled
🧪 CI Test / test shard (2/4) (push) Has been cancelled
🧪 CI Test / test shard (3/4) (push) Has been cancelled
🧪 CI Test / test shard (4/4) (push) Has been cancelled
🧪 CI Test / test (push) Has been cancelled
🧪 CI Test / eslint (push) Has been cancelled
🧪 CI Test / typecheck (push) Has been cancelled
🔫 Sync to Pro / dispatch-sync (push) Has been cancelled
🔮 Sync Mirror / sync (push) Has been cancelled
42 lines
1.2 KiB
Markdown
42 lines
1.2 KiB
Markdown
# @univerjs/sheets-note
|
|
|
|
[](https://npmjs.com/package/@univerjs/sheets-note)
|
|
[](https://npmjs.com/package/@univerjs/sheets-note)
|
|
[](https://npmjs.com/package/@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 |
|
|
| --- | --- | :---: | :---: | :---: |
|
|
| `@univerjs/sheets-note` | `UniverSheetsNote` | No | No | Yes |
|
|
|
|
## Installation
|
|
|
|
```sh
|
|
pnpm add @univerjs/sheets-note
|
|
# or
|
|
npm install @univerjs/sheets-note
|
|
```
|
|
|
|
Keep all `@univerjs/*` packages on the same version.
|
|
|
|
## Usage
|
|
|
|
```ts
|
|
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.
|
|
|
|
## Resources
|
|
|
|
- [Documentation](https://docs.univer.ai)
|
|
- [NPM package](https://npmjs.com/package/@univerjs/sheets-note)
|
|
- [GitHub repository](https://github.com/dream-num/univer)
|