API Reference

@univerjs-pro/boards-ui

Canvas, viewport, selection, shape editing, connectors, sticky notes, ink interaction, toolbar, and context menu UI for Univer Boards.

TypeScript
import { UniverBoardsUIPlugin } from '@univerjs-pro/boards-ui'import '@univerjs-pro/boards-ui/lib/index.css'univer.registerPlugin(UniverBoardsUIPlugin)

Entry Points

  • Facade: @univerjs-pro/boards-ui/facade
  • Locale: @univerjs-pro/boards-ui/locale/*
  • Style: @univerjs-pro/boards-ui/lib/index.css

Facade API

The Facade entry extends FBoard with settings, object-list controls, text search, viewport focus, rendered-layout analysis, and PNG screenshot capture. See the Boards Facade reference.

How is this guide?

© 2026 DreamNum Co., Ltd.