# @univerjs-pro/sheets-exchange-client

> Language fallback: requested `zh-CN`; content is `en-US`.

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

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

- Requested language: `zh-CN`

- Content language: `en-US`

- Documentation version: `1.0.0-rc.0`

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

---

Spreadsheet import and export client integration for Web SDK.

```typescript
// [!code word:UniverSheetsExchangeClientPlugin]
// [!code word:IUniverSheetsExchangeClientConfig]
import { UniverSheetsExchangeClientPlugin } from '@univerjs-pro/sheets-exchange-client'

univer.registerPlugin(UniverSheetsExchangeClientPlugin)
```

## Entry Points

* Facade: `@univerjs-pro/sheets-exchange-client/facade`
* Locale: `@univerjs-pro/sheets-exchange-client/locale/*`

## Facade API

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

importSheetToUnitIdAsync(file: File | string): Promise<string | undefined>
importSheetToSnapshotAsync(file: File | string): Promise<IWorkbookData | undefined>
exportSheetByUnitIdAsync(unitId: string, format?: ExchangeFormat, sheetId?: string): Promise<File | undefined>
exportSheetBySnapshotAsync(snapshot: IWorkbookData, format?: ExchangeFormat, sheetId?: string): Promise<File | undefined>
transformSnapshotJsonToWorkbookDataAsync(json: ISnapshotBlockJsonResponse): Promise<IWorkbookData>
transformWorkbookDataToSnapshotJsonAsync(workbookData: IWorkbookData): Promise<ISnapshotBlockJson>
```

## IUniverSheetsExchangeClientConfig

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

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