配置评论

评论嵌入在协作云中的文档内。要启用评论，请集成 TiptapCollabProvider 并配置您的设置以支持评论功能。

提供者

TiptapCollabProvider 实例

默认值: null

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

Comments.configure({
  provider: tiptapCollabProvider,
})

类别

用于线程的类。

默认值：

{
  thread: 'tiptap-thread',
  threadInline: 'tiptap-thread--inline',
  threadBlock: 'tiptap-thread--block',
  threadHovered: 'tiptap-thread--hovered',
  threadSelected: 'tiptap-thread--selected',
  threadResolved: 'tiptap-thread--resolved',
  threadUnresolved: 'tiptap-thread--unresolved',
}

Comments.configure({
  classes: {
    thread: 'my-thread',
    threadInline: 'my-thread-inline',
    threadBlock: 'my-thread-block',
    threadHovered: 'my-thread-hovered',
    threadSelected: 'my-thread-selected',
    threadResolved: 'my-thread-resolved',
    threadUnresolved: 'my-thread-unresolved',
  },
})

onClickThread

点击线程时调用的回调。如果线程被点击，线程 ID 会传递给回调。如果没有点击任何线程，则传递 null。

默认值: undefined

Comments.configure({
  // ID 可以是字符串或 null
  onClickThread: (id) => console.log('线程被点击', id),
})

deleteUnreferencedThreads

一个布尔选项，用于控制是否删除文档中未引用的线程。默认情况下，当线程不再被文档引用时，它们会被标记为已删除。这对于清理不再需要的线程非常有用。

但是，如果您想保留这些线程，即使它们未被文档引用，您可以将此选项设置为 false。

默认值: true

Comments.configure({
  // 即使未被文档引用也保留线程
  deleteUnreferencedThreads: false,
})

useLegacyWrapping

警告

新的包裹机制为块节点上的线程使用了不同的模式，这与之前的包裹行为不兼容。如果将此设置为 false 而未将现有线程节点映射到新模式，则线程内容将从文档中删除。

一个布尔选项，用于控制是否对多行评论使用遗留的包裹机制。我们建议新的实现将其设置为 false，现有集成可以保持之前的行为。这仅在与现有评论的向后兼容性方面是必要的，并且未来将被移除。

新的包裹机制更加灵活，允许更精确地包裹内容，并支持内联和块节点的混合包裹。

默认值: true

Comments.configure({
  // 启用新的灵活块包装
  useLegacyWrapping: false,
})