协作扩展
这个小指南将快速演示如何将基本的协作功能集成到您的编辑器中。有关适当的协作集成，请查看Tiptap 协作的文档，这是一个云和本地的协作服务器解决方案。
安装
更多详细信息
有关如何与 Tiptap 协作产品集成、安装和配置协作扩展的更详细信息，请访问我们的功能页面。
npm install @tiptap/extension-collaboration @tiptap/y-tiptap yjs y-websocket设置
document
初始化的 Y.js 文档。
默认值: null
Collaboration.configure({
document: new Y.Doc(),
})field
Y.js 片段的名称，可以更改为与一个 Y.js 文档同步多个字段。
默认值: 'default'
Collaboration.configure({
document: new Y.Doc(),
field: 'title',
})fragment
原始的 Y.js 片段，可以替代 document 和 field 使用。
默认值: null
Collaboration.configure({
fragment: new Y.Doc().getXmlFragment('body'),
})命令
Collaboration 扩展带有其自己的历史扩展。如果您使用的是 StarterKit，请确保禁用 UndoRedo 扩展。
undo()
撤销最后一次更改。
editor.commands.undo()redo()
重做最后一次更改。
editor.commands.redo()快捷键
| 命令 | Windows/Linux | macOS |
|---|---|---|
| undo() | Control + Z | Cmd + Z |
| redo() | Shift + Control + Z 或 Control + Y | Shift + Cmd + Z 或 Cmd + Y |
源代码
packages/extension-collaboration/
你做到了！
您的编辑器现在是协作的！邀请您的朋友，一起开始打字 🙌🏻 如果您想继续构建协作编辑功能，请确保查看Tiptap 协作文档，以获取完全托管的本地协作服务器解决方案。