API Reference

@univerjs-pro/boards-print

Print the active Univer Board page or export it as PNG or JPEG.

See Print for the end-to-end integration guide.

Register the plugin

TypeScript
import { ExportBoardImageOperation, PrintBoardOperation, UniverBoardsPrintPlugin } from '@univerjs-pro/boards-print'import '@univerjs-pro/boards-print/lib/index.css'univer.registerPlugin(UniverBoardsPrintPlugin)

Merge @univerjs-pro/boards-print/locale/<locale> into your Univer locale map to localize the ribbon labels.

Run the output actions

The ribbon invokes the same operations shown below. format accepts png or jpeg.

TypeScript
await univerAPI.executeCommand(PrintBoardOperation.id)await univerAPI.executeCommand(ExportBoardImageOperation.id, { format: 'png' })

Entry Points

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

The root entry also exports BoardPrintCompositionService and its element-transform contracts for custom print composition.

IUniverBoardsPrintConfig

TypeScript
import type { MenuConfig } from '@univerjs/ui'export interface IUniverBoardsPrintConfig {  menu?: MenuConfig}

How is this guide?

© 2026 DreamNum Co., Ltd.