---
title: "实时协作"
description: "实时协作扩展支持多人同时编辑文档，并显示其他人的输入位置。"
canonical_url: "https://tiptap.zhcndoc.com/editor/extensions/collaboration"
---

# 实时协作

实时协作扩展支持多人同时编辑文档，并显示其他人的输入位置。

## 使用场景

- **共同编辑。** Collaboration 会将编辑器与 Y.js 文档同步，让多人能够同时编辑。
- **查看彼此的位置。** Collaboration Caret 会在其他人输入时显示他们的光标、选区、姓名和颜色。

## 工作原理

- **需要同步服务器。** 将编辑器连接到 Tiptap Cloud 或自托管的 [Document Server](https://tiptap.zhcndoc.com/collaboration/getting-started/overview.md)，也可以连接到开源项目 [Hocuspocus](https://tiptap.zhcndoc.com/hocuspocus/getting-started/overview.md)。
- **Collaboration Caret 依赖 Collaboration。** 它需要 Y.js provider，以及当前用户的姓名和颜色。它没有默认样式，因此需要为光标添加 CSS。
- **Collaboration 有自己的撤销和重做机制。** 请关闭[撤销和重做](https://tiptap.zhcndoc.com/editor/extensions/functionality/undo-redo.md)扩展；使用 StarterKit 时设置 `undoRedo: false`。
- **需要手动添加。** 这两个扩展都不包含在 [StarterKit](https://tiptap.zhcndoc.com/editor/extensions/functionality/starterkit.md) 中。

## 相关内容

- 参阅[安装 Collaboration](https://tiptap.zhcndoc.com/collaboration/getting-started/install.md)，将其与 Document Server 搭配使用。
- [文档辅助](https://tiptap.zhcndoc.com/editor/extensions/document-helpers.md)介绍 Unique ID；请在协作 provider 完成同步后再挂载它。
