# @univerjs-pro/exchange-client

[![npm version](https://img.shields.io/npm/v/@univerjs-pro/exchange-client?style=flat-square)](https://npmjs.com/package/@univerjs-pro/exchange-client)
[![license](https://img.shields.io/npm/l/@univerjs-pro/exchange-client?style=flat-square)](https://npmjs.com/package/@univerjs-pro/exchange-client)
[![downloads](https://img.shields.io/npm/dm/@univerjs-pro/exchange-client?style=flat-square)](https://npmjs.com/package/@univerjs-pro/exchange-client)

`@univerjs-pro/exchange-client` is part of Univer Pro. Workbook import and export client integration for Univer Pro.

## Package Overview

| Package | UMD global | CSS | Locales | Facade entry | Worker entry |
| --- | --- | :---: | :---: | :---: | :---: |
| `@univerjs-pro/exchange-client` | `UniverProExchangeClient` | No | No | Yes | No |

## Installation

```sh
pnpm add @univerjs-pro/exchange-client
# or
npm install @univerjs-pro/exchange-client
```

## Usage

Start with the [integration setup](https://docs.univer.ai/) for your document type, including its required plugins, styles, and locale resources. The snippet below assumes that setup is complete.

```ts
import { UniverExchangeClientPlugin } from '@univerjs-pro/exchange-client';

univer.registerPlugin(UniverExchangeClientPlugin);
```

## Integration Notes

- Load styles and locale resources from the existing product UI packages that your application uses; this transport package contributes neither.
- Use the facade entry when integrating through Univer Facade APIs.

## Resources

- [Documentation](https://docs.univer.ai)
- [NPM package](https://npmjs.com/package/@univerjs-pro/exchange-client)
- [GitHub repository](https://github.com/dream-num/univer-pro)
