大网数据广告活动
Web 标准与前端开发

HighlightRegistry

· 52CE 我爱测

CSS 自定义高亮 API 的 **`HighlightRegistry`** 接口用于注册 Highlight 对象,以便使用该 API 设置样式。可通过 CSS.highlights_static 访问该接口。

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);

结果

注册高亮

规范

浏览器兼容性

参见

来源:MDN Web Docs / Mozilla 贡献者 · 作者与贡献记录 · CC BY-SA 2.5。离线整理了版式、链接和媒体显示。

资料来源与适用范围

资料来源
MDN Web Docs / Mozilla 贡献者
适用范围
请按文中版本与环境说明核对
内容语言
中文;命令、路径和错误标识保留技术原文
本地收录日期
2026-11-15
授权说明
CC BY-SA 2.5

正文与所需资源由本站本地存储。查看来源及更新记录 ↗

请按适用版本和实际日志确认原因;本站没有对每一种系统或设备逐项执行文中的操作。