# @univerjs-pro/boards-print

- Human documentation: [https://docs.univer.ai/reference/packages/plugins/univerjs-pro/boards-print](https://docs.univer.ai/reference/packages/plugins/univerjs-pro/boards-print)

- Agent Markdown: [https://docs.univer.ai/reference/packages/plugins/univerjs-pro/boards-print.md](https://docs.univer.ai/reference/packages/plugins/univerjs-pro/boards-print.md)

- Requested language: `en-US`

- Content language: `en-US`

- Documentation version: `1.0.0-rc.0`

- Source: [packages/plugins/univerjs-pro/boards-print.mdx](https://github.com/dream-num/documentation/blob/dev/content/reference/packages/plugins/univerjs-pro/boards-print.mdx)

---

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

See [Print](https://docs.univer.ai/guides/boards/features/print.md) 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

```ts
import type { MenuConfig } from '@univerjs/ui'

export interface IUniverBoardsPrintConfig {
  menu?: MenuConfig
}
```