# 协同编辑

- Human documentation: [https://docs.univer.ai/zh-CN/guides/boards/features/collaboration](https://docs.univer.ai/zh-CN/guides/boards/features/collaboration)

- Agent Markdown: [https://docs.univer.ai/zh-CN/guides/boards/features/collaboration.md](https://docs.univer.ai/zh-CN/guides/boards/features/collaboration.md)

- Requested language: `zh-CN`

- Content language: `zh-CN`

- Documentation version: `1.0.0-rc.0`

- Source: [boards/features/collaboration.zh-CN.mdx](https://github.com/dream-num/documentation/blob/dev/content/guides/boards/features/collaboration.zh-CN.mdx)

---

#### Package metadata

```json
{
  "preset": [],
  "plugins": [
    {
      "client": "@univerjs-pro/collaboration"
    },
    {
      "client": "@univerjs-pro/collaboration-client",
      "facade": "@univerjs-pro/collaboration-client/facade",
      "locale": "@univerjs-pro/collaboration-client/locale/zh-CN"
    },
    {
      "client": "@univerjs-pro/collaboration-client-ui",
      "facade": "@univerjs-pro/collaboration-client-ui/facade",
      "locale": "@univerjs-pro/collaboration-client-ui/locale/zh-CN",
      "style": "@univerjs-pro/collaboration-client-ui/lib/index.css"
    }
  ],
  "license": true,
  "server": true
}
```

让多个用户打开同一份画板，实时查看彼此的修改。先按[协同集成](https://docs.univer.ai/zh-CN/server/collaboration/browser-integration.md)接入服务端、登录、权限和持久化存储，再完成[许可证配置](https://docs.univer.ai/zh-CN/guides/license.md)。

## 配置并加载文档

在已有 Boards 编辑器中加入 Collaboration Client 配置，具体步骤见 [Office 快速开始](https://docs.univer.ai/zh-CN/server/collaboration/quick-start.md)。示例演示 Sheets；业务后端需要创建和保存 Boards 类型的文档，并将文档 ID 返回给前端。

```ts
import '@univerjs-pro/boards/facade'
import '@univerjs-pro/collaboration-client/facade'

const document = await univerAPI.getCollaboration().loadBoardAsync('your-document-id')
if (!document) throw new Error('Document could not be loaded')
```

重新打开或分享文档时使用同一个 ID。不要创建本地空白文档来代替加载服务端文档。

## 验证同步和权限

用两个独立浏览器会话加载同一个 ID，在一端移动画板元素或修改文字，确认另一端收到变化。刷新页面、断线重连和重启服务后，再检查内容是否保留。使用查看者和无权限用户检查服务端是否拒绝未授权的修改或读取。

[历史记录](https://docs.univer.ai/zh-CN/guides/boards/features/edit-history.md)和[导入导出](https://docs.univer.ai/zh-CN/guides/boards/features/import-export.md)需要另外配置，启用协同不会自动启用这些功能。