@univerjs-pro/boards-ui
v1.0.2
Published
Board UI integration for Univer.
Readme
@univerjs-pro/boards-ui
@univerjs-pro/boards-ui is part of Univer Pro. Board UI integration for Univer.
Package Overview
| Package | UMD global | CSS | Locales | Facade entry |
| --- | --- | :---: | :---: | :---: |
| @univerjs-pro/boards-ui | UniverProBoardsUi | Yes | Yes | No |
Installation
pnpm add @univerjs-pro/boards-ui
# or
npm install @univerjs-pro/boards-uiKeep all @univerjs/* and @univerjs-pro/* packages on the same version.
Usage
import '@univerjs-pro/boards-ui/lib/index.css';
import EnUS from '@univerjs-pro/boards-ui/locale/en-US';
import { UniverBoardsUIPlugin } from '@univerjs-pro/boards-ui';
univer.registerPlugin(UniverBoardsUIPlugin);
// Merge EnUS into your Univer locale map when this package contributes UI text.Integration Notes
- Keep this package on the same version as the other
@univerjs/*and@univerjs-pro/*packages in your application. - Import the package stylesheet once in the application entry before rendering Univer UI.
- Import locale files only for the languages your application enables.
Viewport bars
When enabled, viewport bars remain hidden while the Board is idle. Panning or zooming reveals them until one second after the last viewport change. Moving the pointer within 24 pixels of the bottom or right edge reveals the corresponding bar; dragging a bar keeps it visible until the gesture ends. Hidden bars do not capture pointer input.
Screenshot readiness
Board screenshots wait for render resources and measured connector labels, not just successful data insertion. Font loading must complete and the Board renderer must refresh its font metrics before capture can stabilize. If another font load starts during capture, the stable-frame count restarts; identical fallback pixels do not prove readiness. Missing or unresolved resources use the existing bounded resource timeout. A failed capture restores any selection and viewport state that it temporarily changed.
Capture bounds are caller-supplied. Resolve rendered bounds after layout is ready when AutoSize or FixedWidth labels may extend beyond their original geometry; headless dimensions are not a measured crop rectangle.
