@univerjs-pro/boards
@univerjs-pro/boards provides the core board unit, data model, commands, mutations, services, and facade entry for Univer Board.
Package Overview
| Package | UMD global | CSS | Locales | Facade entry |
|---|---|---|---|---|
@univerjs-pro/boards |
UniverProBoards |
No | No | Yes |
Capabilities
- Registers
UniverInstanceType.UNIVER_BOARDand theBoardModelunit constructor. - Provides board snapshots, page and element types, theme data, page settings, and empty snapshot helpers.
- Registers board element mutations and operations for inserting, updating, deleting, ordering, grouping, containers, swimlanes, connectors, tables, mind maps, ink, and resource-driven elements.
- Exposes adapter services so feature packages can add chart, table, pen, mind map, import, export, translate, and resource integrations without coupling to the base package.
- Provides
@univerjs-pro/boards/facadefor SDK-style board creation and element operations.
Installation
pnpm add @univerjs-pro/boards
# or
npm install @univerjs-pro/boardsKeep all @univerjs/* and @univerjs-pro/* packages on the same version.
Usage
import { UniverBoardsPlugin } from '@univerjs-pro/boards';
univer.registerPlugin(UniverBoardsPlugin);Create board units with the board instance type:
import { UniverInstanceType } from '@univerjs/core';
univer.createUnit(UniverInstanceType.UNIVER_BOARD, {});Integration Notes
Use this package as the foundation for board scenarios. Applications that need an interactive canvas should also register @univerjs-pro/boards-ui. Feature packages such as @univerjs-pro/boards-mind, @univerjs-pro/boards-table, and @univerjs-pro/ink build on the services exported here.