探索 Tiptap V3 的最新功能

CollaborationCaret 扩展

版本下载量

此扩展添加了有关所有连接用户的信息(如他们的名字和指定的颜色)、他们当前的光标位置和他们的文本选择(如果有的话)。

它需要一个协作编辑器,因此请确保查看 Tiptap 协作文档,以获取完全托管或本地部署的协作服务器解决方案。

公开演示

此编辑器的内容与其他用户共享。

在多个浏览器窗口中打开此页面进行测试。

安装

npm install @tiptap/extension-collaboration-caret

此扩展需要 Collaboration 扩展。

设置

provider

一个 Y.js 网络提供者,例如一个 Tiptap 协作 实例。

默认值: null

user

当前用户的属性,假设有名字和颜色,但可以用于任何属性。这些值与所有其他连接的客户端进行同步。

默认值: { user: null, color: null }

render

光标的渲染函数,查看 扩展源代码 以获取示例。

selectionRender

选择的渲染函数,查看 扩展源代码 以获取示例。

命令

updateUser()

传递一个包含当前用户更新属性的对象。它期望有一个 name 和一个 color,但你也可以添加其他字段。

editor.commands.updateUser({
  name: 'John Doe',
  color: '#000000',
  avatar: 'https://unavatar.io/github/ueberdosis',
})

源代码

packages/extension-collaboration-caret/

协作

系好安全带!使你的富文本编辑器通过 Tiptap 协作进行协作。

  • 实时一切
  • 离线优先 & 无冲突
  • 由我们管理和托管或在你的场所