Custom Components

@univerjs-pro/boards-ui exports the components and extension services used by the Board canvas. They require an initialized Univer injector and Board unit; they are not standalone design-system widgets.

Public canvas components

TypeScript
import {  BoardShapeTextEditorContainer,  BoardWorkbench,} from '@univerjs-pro/boards-ui'

The plugin registers its shape and connector floating toolbars internally. Applications should use the supported services instead of replacing private component keys.

Supported extension points

  • IBoardToolbarContributionService adds create or auxiliary actions to Board toolbars.
  • IBoardSettingsMenuContributionService adds action, import, or output entries to the settings menu.
  • IBoardSidePanelService opens a Board side panel and returns a disposable handle.
  • additionalRenderAdapters adds renderers without replacing the built-in BOARD_ELEMENT_RENDER_ADAPTERS list.
  • registerBoardDocumentTextExtension extends rendering for Board document text.

Dispose every registration when the host plugin is removed.

How is this guide?

© 2026 DreamNum Co., Ltd.