@univerjs-pro/boards-exchange-client
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
TypeScript
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'// univerAPIexportBoardByUnitIdAsync(unitId: string): Promise<File | undefined>exportBoardBySnapshotAsync(snapshot: IBoardData): Promise<File | undefined>transformSnapshotJsonToBoardDataAsync(json: ISnapshotBlockJsonResponse): Promise<IBoardData>transformBoardDataToSnapshotJsonAsync(boardData: IBoardData): Promise<ISnapshotBlockJson>// FBoardinsertMermaidAsync(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
How is this guide?