安装评论扩展

Available from Start planBeta

通过遵循本指南安装并配置评论扩展。请查看本页底部的评论示例应用程序以获取完整的集成。

访问私有注册表

评论扩展发布在 Tiptap 的私有 npm 注册表中。通过遵循私有注册表指南集成该扩展。

npm install @tiptap-pro/extension-comments

集成评论扩展

通过 npm 或其他包管理器安装 comments 扩展后，可以在您的编辑器中通过在编辑器实例的 extensions 属性中注册该扩展来使用它。

评论扩展由多个组件组成，包括节点和插件。要包括所有所需功能，请使用 CommentsKit 扩展。

import { CommentsKit } from '@tiptap-pro/extension-comments'

const editor = new Editor({
  ...
  extensions: [
    ...,
    CommentsKit,
  ]
})

这将把所有必需的扩展添加到您的编辑器中。由于线程是一个云或本地功能，您还需要将 TiptapCollabProvider 实例传递给您的评论扩展。

const collabProvider = new TiptapCollabProvider({
  // 您的提供者选项
})

const editor = new Editor({
  ...
  extensions: [
    ...,
    CommentsKit.configure({
      provider: collabProvider,
    }),
  ]
})

您的编辑器现在已准备好支持线程。

请查看以下示例中如何使用评论扩展的完整示例：