@univerjs-pro/boards-ui

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

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

Menu configuration and canvas toolbar

Boards context menus use MenuConfig from UniverUIPlugin. Configure items such as board.menu.duplicate-selection with order, hidden, or other item overrides. Import @univerjs/ui/facade to update them through FUniver.updateMenuConfig(). Pass menu to the shared UI plugin, not UniverBoardsUIPlugin.

The Board canvas toolbar is independent of the standard Ribbon. Its tools are controlled by UniverBoardsUIPlugin.toolbar.tools, a partial map keyed by BoardToolType from @univerjs-pro/boards. Each value is a boolean or { enabled?: boolean }:

univer.registerPlugin(UniverBoardsUIPlugin, {  toolbar: { tools: { pen: false } },})

This controls tool availability, not order or grid placement. Ribbon gridLayout does not rearrange the canvas toolbar or context menus. See the Boards menu guide for configuration and runtime examples.

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.