Tiptap 中文文档

命令

BetaPilot program

使用这些命令前，请先将 Compare 扩展添加到编辑器。

compareDocuments

比较两个 Tiptap JSON 文档并显示变化。

此命令等同于调用 compareDocuments 后立即调用 displayChangeset。

Parameters (CompareDocumentsOptions)

  • docA (JSONContent)：原始文档。
  • docB (JSONContent)：变更后的文档。
  • diffOptions? (DiffOptions)：控制比较方式的选项。
  • displayOptions? (DisplayOptions)：控制差异渲染的选项。

Returns (boolean)

  • boolean：比较文档并创建差异建议后返回 true。

compareFragments

比较两个 Tiptap JSON 片段并显示变化。

此命令等同于调用 compareFragments 后立即调用 displayChangeset。

Parameters (CompareFragmentsOptions)

  • fragmentA (JSONContent[] | null)：原始片段。
  • fragmentB (JSONContent[] | null)：变更后的片段。
  • diffOptions? (DiffOptions)：控制比较方式的选项。
  • displayOptions? (DisplayOptions)：控制差异渲染的选项。

Returns (boolean)

  • boolean：比较片段并创建差异建议后返回 true。

compareSteps

比较一组文档步骤并显示变化。

此命令等同于调用 compareSteps 后立即调用 displayChangeset。

Parameters (CompareStepsOptions)

  • stepSequence (StepSequence)：要比较的步骤序列。每个步骤都可以包含相关元数据，例如完成该步骤的用户。
  • compareMetadata? ((a: ChangeMetadata, b: ChangeMetadata) => boolean)：决定相邻步骤是否可以分组。
  • diffOptions? (DiffOptions)：控制比较方式的选项。
  • displayOptions? (DisplayOptions)：控制差异渲染的选项。

Returns (boolean)

  • boolean：比较步骤并创建差异建议后返回 true。

compareVersions

比较两个 Yjs 版本更新并显示变化。

此命令等同于调用 compareVersions 后立即调用 displayChangeset。

Parameters (CompareVersionsOptions)

  • versionA (Uint8Array)：较旧的 Yjs v2 更新。
  • versionB (Uint8Array)：较新的 Yjs v2 更新。
  • diffOptions? (DiffOptions)：控制比较方式的选项。
  • compareMetadata? ((a: ChangeMetadata, b: ChangeMetadata) => boolean): Decides whether adjacent changes can be grouped.
  • field? (string)：Yjs 文档字段。默认值：'default'。
  • permanentUserDataMapField? (string)：共享用户数据映射字段。默认值：'__tiptapcollab__users'。
  • enableDebugging? (boolean)：启用提取日志。默认值：false。
  • displayOptions? (DisplayOptions)：控制差异渲染的选项。

Returns (boolean)

  • boolean：比较版本并创建差异建议后返回 true。

displayChangeset

在编辑器中将 changeset 显示为审阅建议。编辑器显示当前文档（Changeset.docB），每条建议提供原始文档（Changeset.docA）中的对应内容。

Parameters (DisplayChangesetOptions)

  • changeset (Changeset)：要显示的比较结果。
  • displayOptions? (DisplayOptions)：控制差异渲染的选项。

Returns (boolean)

  • boolean：加载 changeset 并创建差异建议后返回 true。

displayChangesetAsTrackedChanges

将 changeset 加载为修订记录建议。编辑器显示变更后的文档（Changeset.docB），并将新增、删除、替换和格式变化编码为修订记录。所有正在显示的差异建议都会被清除。

Parameters (DisplayChangesetAsTrackedChangesOptions)

  • changeset (Changeset)：要显示的比较结果。

Returns (boolean)

  • boolean：加载文档并创建修订记录后返回 true。

setDiffSuggestions

设置当前显示的差异建议列表。

Parameters

  • diffSuggestions (DiffSuggestion[])：要显示的建议。传入空数组可清除建议。

Returns (boolean)

  • boolean：替换活动建议后返回 true。

acceptDiffSuggestion

接受一条差异建议。停止显示该建议，并保持文档当前内容不变。

Parameters

  • diffSuggestionId (string)：要接受的建议 ID。

Returns (boolean)

  • boolean：找到并接受建议时返回 true，否则返回 false。

rejectDiffSuggestion

拒绝一条差异建议。将建议的替换内容应用到文档，以恢复之前的版本。

Parameters

  • diffSuggestionId (string)：要拒绝的建议 ID。

Returns (boolean)

  • boolean：找到并拒绝建议时返回 true，否则返回 false。

acceptAllDiffSuggestions

接受所有活动建议，或接受经过筛选的建议。

Parameters (AllDiffSuggestionsOptions)

  • filter? ((diffSuggestion: DiffSuggestion) => boolean)：选择要接受的建议。默认接受所有建议。

Returns (boolean)

  • boolean：处理选定建议后返回 true。

rejectAllDiffSuggestions

拒绝所有活动建议，或拒绝经过筛选的建议。

Parameters (AllDiffSuggestionsOptions)

  • filter? ((diffSuggestion: DiffSuggestion) => boolean)：选择要拒绝的建议。默认拒绝所有建议。

Returns (boolean)

  • boolean：处理选定建议后返回 true。
Previously分栏视图