API Reference

@univerjs-pro/pdfs-exchange-client

PDF import and export client integration for Web SDK.

TypeScript
import { UniverPdfsExchangeClientPlugin } from '@univerjs-pro/pdfs-exchange-client'univer.registerPlugin(UniverPdfsExchangeClientPlugin)

The plugin config accepts an optional menu value, which is merged into the shared Univer menu configuration. The root entry exports PdfsExchangeClientMenuSchema and IPdfExchangeService for custom integrations, but not the config type.

Entry points

  • Facade: @univerjs-pro/pdfs-exchange-client/facade
  • Locale: @univerjs-pro/pdfs-exchange-client/locale/*

Facade API

TypeScript
import '@univerjs-pro/pdfs-exchange-client/facade'importPdfToUnitIdAsync(file: File | string): Promise<string | undefined>importPdfToSnapshotAsync(file: File | string): Promise<IPdfUnitData | undefined>exportPdfByUnitIdAsync(unitId: string): Promise<File | undefined>exportPdfBySnapshotAsync(snapshot: IPdfUnitData): Promise<File | undefined>transformSnapshotJsonToPdfDataAsync(json: ISnapshotBlockJsonResponse): Promise<IPdfUnitData>transformPdfDataToSnapshotJsonAsync(pdfData: IPdfUnitData): Promise<ISnapshotBlockJson>

Import @univerjs-pro/exchange-client/facade as well when using the shared downloadFile(file, filename, fileExt) helper. See PDF import and export for the complete workflow.

How is this guide?

© 2026 DreamNum Co., Ltd.