CSS Custom Highlight API
CSS 自定义高亮 API 的 HighlightRegistry 接口用于注册 Highlight 对象,以便使用该 API 设置样式。可通过 CSS.highlights_static 访问该接口。
HighlightRegistry 实例是一个类 Map 对象,其中每个键都是自定义高亮的名称字符串,对应的值是关联的 Highlight 对象。
实例属性
HighlightRegistry 接口不继承任何属性。
- HighlightRegistry.size
- : 返回当前已注册的
Highlight对象的数量。
- : 返回当前已注册的
实例方法
HighlightRegistry 接口不继承任何方法。
- HighlightRegistry.clear()
- : 从注册表中移除所有
Highlight对象。
- : 从注册表中移除所有
- HighlightRegistry.delete()
- : 从注册表中删除具有指定名称的
Highlight对象。
- : 从注册表中删除具有指定名称的
- HighlightRegistry.entries()
- : 返回一个新的迭代器对象,该对象包含了注册表中的所有
Highlight对象,按插入顺序排列。
- : 返回一个新的迭代器对象,该对象包含了注册表中的所有
- HighlightRegistry.forEach()
- : 按插入顺序为注册表中的每个
Highlight对象执行一次提供的函数。
- : 按插入顺序为注册表中的每个
- HighlightRegistry.get()
- : 从注册表中获取指定的
Highlight对象。
- : 从注册表中获取指定的
- HighlightRegistry.has()
- : 返回一个指示对应的
Highlight对象是否存在于该注册表中的布尔值。
- : 返回一个指示对应的
- HighlightRegistry.keys()
- : HighlightRegistry.values() 方法的别名。
- HighlightRegistry.set()
- : 添加给定名称的
Highlight对象到注册表,如果该名称的对象已存在则覆盖原值。
- : 添加给定名称的
- HighlightRegistry.values()
- : 返回一个新的迭代器对象,该对象包含此注册表中每个
Highlight对象,按插入顺序排列。
- : 返回一个新的迭代器对象,该对象包含此注册表中每个
示例
注册高亮
以下示例演示了如何创建多个文本范围,然后为它们创建 Highlight 对象,并在 HighlightRegistry 中注册该高亮显示:
HTML
<p id="foo">CSS 自定义高亮 API</p>
CSS
::highlight(my-custom-highlight) {
background-color: peachpuff;
}
JavaScript
const text = document.getElementById("foo").firstChild;
if (!CSS.highlights) {
text.textContent = "此浏览器不支持 CSS 自定义高亮 API!";
}
// 创建多个文本范围。
const range1 = new Range();
range1.setStart(text, 0);
range1.setEnd(text, 3);
const range2 = new Range();
range2.setStart(text, 10);
range2.setEnd(text, 13);
// 为文本范围创建自定义高亮。
const highlight = new Highlight(range1, range2);
// 在 HighlightRegistry 中注册文本范围。
CSS.highlights.set("my-custom-highlight", highlight);
结果
注册高亮
规范
浏览器兼容性
参见
- css_custom_highlight_api
- CSS 自定义高亮 API:网页文本范围高亮的未来
来源:MDN Web Docs / Mozilla 贡献者 · 作者与贡献记录 · CC BY-SA 2.5。离线整理了版式、链接和媒体显示。
