Tiptap 中文文档

命令

Paid add-on

受控变更扩展提供的所有编辑器命令。

enableTrackedChanges()

启用受控变更模式。所有后续编辑将变为建议。

editor.commands.enableTrackedChanges()

disableTrackedChanges()

禁用受控变更模式。编辑将直接应用到文档中。

editor.commands.disableTrackedChanges()

toggleTrackedChanges()

切换受控变更模式开关。

editor.commands.toggleTrackedChanges()

setTrackedChangesUser()

更改新建议的当前用户。

参数类型描述
userIdstring新的用户 ID
userMetadataRecord<string, unknown> | null关于用户的可选任意元数据
editor.commands.setTrackedChangesUser({
  userId: 'user-789',
  userMetadata: { name: 'Alice Johnson' },
})

acceptSuggestion()

接受建议，应用提议的更改。对于插入，移除建议标记并保留文本。对于删除，移除标记文本。对于替换，移除旧文本，保留新文本。

参数类型描述
idstring可选的建议 ID。若省略，则使用当前选区处的建议。
// 接受选区处的建议
editor.commands.acceptSuggestion()

// 接受特定建议
editor.commands.acceptSuggestion({ id: 'suggestion-123' })

rejectSuggestion()

拒绝建议，撤销提议的更改。对于插入，移除标记文本。对于删除，移除建议标记并保留文本。对于替换，移除新文本，保留旧文本。

参数类型描述
idstring可选的建议 ID。若省略，则使用当前选区处的建议。
// 拒绝选区处的建议
editor.commands.rejectSuggestion()

// 拒绝特定建议
editor.commands.rejectSuggestion({ id: 'suggestion-123' })

acceptAllSuggestions()

接受文档中的所有建议。

editor.commands.acceptAllSuggestions()

rejectAllSuggestions()

拒绝文档中的所有建议。

editor.commands.rejectAllSuggestions()

acceptSuggestionsInRange()

接受特定文档位置范围内的所有建议。

参数类型描述
fromnumber范围起始位置
tonumber范围结束位置
editor.commands.acceptSuggestionsInRange({ from: 0, to: 100 })

rejectSuggestionsInRange()

拒绝特定文档位置范围内的所有建议。

参数类型描述
fromnumber范围起始位置
tonumber范围结束位置
editor.commands.rejectSuggestionsInRange({ from: 0, to: 100 })

acceptSuggestionsByUser()

接受特定用户创建的所有建议。

参数类型描述
userIdstring需要接受建议的用户 ID
editor.commands.acceptSuggestionsByUser({ userId: 'user-123' })

rejectSuggestionsByUser()

拒绝特定用户创建的所有建议。

参数类型描述
userIdstring需要拒绝建议的用户 ID
editor.commands.rejectSuggestionsByUser({ userId: 'user-123' })

addTrackedInsertion()

在不为整个编辑器启用受控变更模式的情况下，将内容作为受控建议插入。当你需要以编程方式创建建议并希望结果匹配正常的受控输入事务时，这很有用。content 参数接受任何 Tiptap Content 值，包括文本、HTML 或 JSON 节点内容（如图像节点）。当 skipTrailingNode 为 true 时，发出的事务也会设置 skipTrailingNode: true，这对于 TrailingNode 扩展很有用。

参数类型描述
fromnumber应添加受控插入的文档位置
contentContent作为建议插入的内容
reasonstring可选描述，包含在 trackedChanges:suggestionCreated 事件负载中
skipTrailingNodeboolean可选标志，在发出的受控事务上设置 skipTrailingNode: true
editor.commands.addTrackedInsertion({
  from: 7,
  content: '大 ',
  reason: '应用 AI 重写',
  skipTrailingNode: true,
})
editor.commands.addTrackedInsertion({
  from: 7,
  content: {
    type: 'image',
    attrs: {
      src: '/example.png',
      alt: '示例图片',
    },
  },
  reason: '插入审核通过的图片素材',
})

addTrackedDeletion()

将现有文档范围转换为受控删除建议。这相当于用户在启用受控变更模式时删除内容的操作。

参数类型描述
fromnumber标记为删除的范围起始位置
tonumber标记为删除的范围结束位置
reasonstring可选描述，包含在 trackedChanges:suggestionCreated 事件负载中
editor.commands.addTrackedDeletion({
  from: 7,
  to: 12,
  reason: '移除过时措辞',
})

addTrackedReplacement()

将现有范围替换为受控替换建议。被替换的内容成为建议的删除部分，新内容成为插入部分。content 参数接受任何 Tiptap Content 值，因此你可以通过传递 JSON 内容用不同的节点替换文本。当 skipTrailingNode 为 true 时，发出的事务也会设置 skipTrailingNode: true，这对于 TrailingNode 扩展很有用。

参数类型描述
fromnumber要替换范围的起始位置
tonumber要替换范围的结束位置
contentContent作为受控建议插入的替换内容
reasonstring可选描述，包含在 trackedChanges:suggestionCreated 事件负载中
skipTrailingNodeboolean可选标志，在发出的受控事务上设置 skipTrailingNode: true
editor.commands.addTrackedReplacement({
  from: 7,
  to: 12,
  content: '地球',
  reason: '替换为批准的术语',
  skipTrailingNode: true,
})
editor.commands.addTrackedReplacement({
  from: 7,
  to: 8,
  content: {
    type: 'image',
    attrs: {
      src: '/updated-diagram.png',
      alt: '更新后的图表',
    },
  },
  reason: '用最终图表替换占位符',
})

addTrackedMark()

将标记应用于现有范围，作为受控 markChange 建议。当你想以编程方式建议格式或其他标记级更改而不全局启用受控变更模式时，请使用此方法。

参数类型描述
fromnumber要标记范围的起始位置
tonumber要标记范围的结束位置
markNamestring要添加的模式标记名称
markAttrsRecord<string, unknown> | null被跟踪标记的可选属性
reasonstring可选描述，包含在 trackedChanges:suggestionCreated 事件负载中
editor.commands.addTrackedMark({
  from: 7,
  to: 12,
  markName: 'bold',
  reason: '强调批准的术语',
})
editor.commands.addTrackedMark({
  from: 7,
  to: 12,
  markName: 'link',
  markAttrs: {
    href: 'https://tiptap.dev',
    target: '_blank',
  },
  reason: '链接到规范参考',
})

removeTrackedMark()

从现有范围移除标记，作为受控 markChange 建议。这反映了用户在启用受控变更模式时移除格式化的操作。

参数类型描述
fromnumber要取消标记范围的起始位置
tonumber要取消标记范围的结束位置
markNamestring要移除的模式标记名称
markAttrsRecord<string, unknown> | null用于识别标记变体的可选属性
reasonstring可选描述，包含在 trackedChanges:suggestionCreated 事件负载中
editor.commands.removeTrackedMark({
  from: 7,
  to: 12,
  markName: 'bold',
  reason: '移除标签的强调',
})

toggleTrackedMark()

在带有跟踪标记建议的现有范围上切换标记。对于混合选择，已标记的片段将变为跟踪删除，未标记的片段将变为跟踪添加，所有这些都在一个命令内完成。

参数类型描述
fromnumber要切换范围的起始位置
tonumber要切换范围的结束位置
markNamestring要切换的 schema 标记名称
markAttrsRecord<string, unknown> | null用于识别或创建标记变体的可选属性
reasonstring包含在 trackedChanges:suggestionCreated 事件负载中的可选描述
editor.commands.toggleTrackedMark({
  from: 7,
  to: 12,
  markName: 'bold',
  reason: 'Toggled emphasis based on editorial review',
})
Previously带评论