样式
付费附加项Beta
建议标记和节点级建议会渲染数据属性,可通过 CSS 定向。
CSS 选择器
/* 所有建议 */
[data-suggestion] {
/* 所有建议的基础样式 */
}
/* 插入 */
[data-suggestion-type="add"] {
background-color: rgba(0, 255, 0, 0.2);
text-decoration: underline;
}
/* 删除 */
[data-suggestion-type="delete"] {
background-color: rgba(255, 0, 0, 0.2);
text-decoration: line-through;
}
/* 替换删除(被替换的旧文本) */
[data-suggestion-type="replaceDeletion"] {
background-color: rgba(255, 0, 0, 0.2);
text-decoration: line-through;
}
/* 替换插入(替换旧文本的新文本) */
[data-suggestion-type="replaceInsertion"] {
background-color: rgba(0, 255, 0, 0.2);
text-decoration: underline;
}
/* 标记更改(添加或删除的格式) */
[data-suggestion-type="markChange"] {
background-color: rgba(255, 200, 0, 0.2);
}
/* 节点属性更改 */
[data-suggestion-type="attributeChange"] {
outline: 2px solid rgb(59, 130, 246);
outline-offset: 2px;
}
/* 建议的块拆分(由跟踪的 Enter 创建的块) */
[data-suggestion-type="blockSplit"] {
box-shadow: inset 2px 0 0 rgb(59, 130, 246);
}
/* 按用户设置建议样式 */
[data-suggestion-user="user-123"] {
border-bottom: 2px solid blue;
}可用的数据属性
| 属性 | 描述 |
|---|---|
data-suggestion | 始终存在于建议标记元素和节点级建议元素上 |
data-suggestion-id | 唯一的建议 ID |
data-suggestion-type | 内部类型:'add'、'delete'、'replaceDeletion'、'replaceInsertion'、'markChange'、'attributeChange'、'sink'、'lift' 或 'blockSplit' |
data-suggestion-user | 创建建议的用户 ID |
data-suggestion-created | 创建建议时的 ISO 时间戳 |
data-suggestion-user-metadata | JSON 序列化的用户元数据对象(仅在设置了 userMetadata 时存在) |
data-suggestion-attribute-changes | JSON 序列化的属性更改(仅在 attributeChange 建议中存在) |
data-suggestion-type 保存的是内部的 SuggestionNodeType,而不是公开类型。块拆分 在这里是 blockSplit,尽管查询 API 将其报告为 split。
节点类型提议还公开 data-suggestion-node-type-change,其中包含 JSON 序列化的原始和提议类型以及原始属性。当删除或拆分共享块时,它还包括格式建议的标识。以 [data-suggestion-node-type-change] 为目标,使这些建议的样式独立于块的主要建议类型。
Block split marker
建议的区块拆分还会在拆分前的区块末尾渲染一个标记,用于显示断点添加的位置。默认标记是一个 class 为 tiptap-tracked-change-split-marker 的 <span>:
.tiptap-tracked-change-split-marker {
color: rgb(59, 130, 246);
opacity: 0.7;
margin-left: 0.15em;
user-select: none;
}每个标记还带有 data-tracked-change-split="true",因此你也可以定位自定义标记:
[data-tracked-change-split] {
color: rgb(59, 130, 246);
}该标记是一个小部件,而不是文档内容。此扩展始终为其设置 contenteditable="false",并禁用选择和指针事件,因此无法在其中输入、选中或点击。使用 blockSplitMarker 更改字符或元素,或将其设置为 null 以不渲染任何内容。
已知限制
此扩展处于积极开发中,未来几个月将会有重大变更。已知以下限制,未来版本会予以解决:
- Nesting is supported for inline suggestions only. Nested suggestions spanning whole blocks are out of scope
- 跟踪节点类型更改 作为
attributeChange建议需要选择加入nodeTypeChangeTypes设置,该设置可供本地编辑器使用。使用 Tiptap Collaboration(Y.js 文档)时,将此设置保留为[]以跟踪类型转换作为替换。 - There is no explicit suggestion mode that renders a separate "clean" document alongside the tracked version