---
title: "协作扩展"
description: "了解如何在 Tiptap 中使用协作扩展来设置和使用协作编辑。"
canonical_url: "https://tiptap.zhcndoc.com/editor/extensions/functionality/collaboration"
---

# 协作扩展

了解如何在 Tiptap 中使用协作扩展来设置和使用协作编辑。

这个小指南将快速演示如何将基本的协作功能集成到您的编辑器中。有关适当的协作集成，请查看[Tiptap 协作](https://tiptap.zhcndoc.com/collaboration/getting-started/overview.md)的文档，这是一个云和本地的协作服务器解决方案。

> **Interactive demo:** [CollaborationSplitPane](https://embed.tiptap.dev/preview/Demos/CollaborationSplitPane)

## 安装

> **更多详细信息:**
>
> 有关如何与 Tiptap 协作产品集成、安装和配置协作扩展的更详细信息，请访问我们的[功能页面](https://tiptap.zhcndoc.com/collaboration/getting-started/overview.md)。

```bash
npm install @tiptap/extension-collaboration @tiptap/y-tiptap yjs y-websocket
```

## 设置

### document

初始化的 Y.js 文档。

默认值: `null`

```js
Collaboration.configure({
  document: new Y.Doc(),
})
```

### field

Y.js 片段的名称，可以更改为与一个 Y.js 文档同步多个字段。

默认值: `'default'`

```js
Collaboration.configure({
  document: new Y.Doc(),
  field: 'title',
})
```

### fragment

原始的 Y.js 片段，可以替代 `document` 和 `field` 使用。

默认值: `null`

```js
Collaboration.configure({
  fragment: new Y.Doc().getXmlFragment('body'),
})
```

## 命令

`Collaboration` 扩展带有其自己的历史扩展。如果您使用的是 `StarterKit`，请确保禁用 `UndoRedo` 扩展。

### undo()

撤销最后一次更改。

```js
editor.commands.undo()
```

### redo()

重做最后一次更改。

```js
editor.commands.redo()
```

## 快捷键

| 命令     | Windows/Linux                     | macOS                     |
| ------ | --------------------------------- | ------------------------- |
| undo() | Control + Z                       | Cmd + Z                   |
| redo() | Shift + Control + Z 或 Control + Y | Shift + Cmd + Z 或 Cmd + Y |

## 使用 UniqueID

如果您将 [UniqueID extension](https://tiptap.zhcndoc.com/editor/extensions/functionality/uniqueid.md) 与 Collaboration 一起使用，请确保仅在协作提供程序完成同步之后才挂载编辑器。错误的初始化顺序可能导致文档中持续出现空段落。有关详细信息，请参阅 [UniqueID: 使用 Collaboration](https://tiptap.zhcndoc.com/editor/extensions/functionality/uniqueid.md#usage-with-collaboration)。

## 源代码

[packages/extension-collaboration/](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-collaboration/)

## 你做到了！

您的编辑器现在是协作的！邀请您的朋友，一起开始打字 🙌🏻 如果您想继续构建协作编辑功能，请确保查看[Tiptap 协作文档](https://tiptap.zhcndoc.com/collaboration/getting-started/overview.md)，以获取完全托管的本地协作服务器解决方案。

协作

系好安全带！让您的富文本编辑器与 Tiptap 协作功能一起工作。

实时一切
优先离线和无冲突
由我们管理和托管或在您本地

[了解更多](https://tiptap.zhcndoc.com/collaboration/getting-started/overview.md)