# @univerjs-pro/boards-exchange-client

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

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

- Requested language: `en-US`

- Content language: `en-US`

- Documentation version: `1.0.0-rc.0`

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

---

Board import and export UI integration, including Mermaid diagram import.

```typescript
import { UniverBoardsExchangeClientPlugin } from '@univerjs-pro/boards-exchange-client'

import '@univerjs-pro/boards-exchange-client/lib/index.css'

univer.registerPlugin(UniverBoardsExchangeClientPlugin)
```

## IUniverBoardsExchangeClientConfig

```ts
export interface IUniverBoardsExchangeClientConfig {
  menu?: MenuConfig
}
```

The package also exports `ExportBoardOperation`, `InsertMermaidOperation`, `BOARD_MERMAID_IMPORT_SOURCE_TYPE`, `BoardMermaidImportService`, `IBoardMermaidImportService`, and `IBoardMermaidImportContext` for custom integrations.

## Facade API

```typescript
import '@univerjs-pro/boards-exchange-client/facade'

// univerAPI
exportBoardByUnitIdAsync(unitId: string): Promise<File | undefined>
exportBoardBySnapshotAsync(snapshot: IBoardData): Promise<File | undefined>
transformSnapshotJsonToBoardDataAsync(json: ISnapshotBlockJsonResponse): Promise<IBoardData>
transformBoardDataToSnapshotJsonAsync(boardData: IBoardData): Promise<ISnapshotBlockJson>

// FBoard
insertMermaidAsync(code: string, options?: IBoardMermaidOptions): Promise<boolean>
```

## Entry Points

* Facade: `@univerjs-pro/boards-exchange-client/facade`
* Locale: `@univerjs-pro/boards-exchange-client/locale/*`
* Style: `@univerjs-pro/boards-exchange-client/lib/index.css`