HighlightRegistry
MDN Web Docs · نسخهٔ df622a2a1c1e · CC BY-SA 2.5 و مجوز جداگانهٔ ناشر برای نمونهکد
{{APIRef("CSS Custom Highlight API")}}
The **HighlightRegistry** interface of the CSS Custom Highlight API is used to register {{domxref("Highlight")}} objects to be styled using the API. It is accessed via {{domxref("CSS.highlights_static", "CSS.highlights")}}.
A HighlightRegistry instance is a [Map-like object](/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map#map-like_browser_apis), in which each key is the name string for a custom highlight, and the corresponding value is the associated {{domxref("Highlight")}} object.
{{InheritanceDiagram}}
Instance properties
_The HighlightRegistry interface doesn't inherit any properties._
- {{domxref("HighlightRegistry.size")}} {{ReadOnlyInline}}
- : Returns the number of
Highlightobjects currently registered.
Instance methods
_The HighlightRegistry interface doesn't inherit any methods_.
- {{domxref("HighlightRegistry.clear()")}}
- : Remove all
Highlightobjects from the registry. - {{domxref("HighlightRegistry.delete()")}}
- : Remove the named
Highlightobject from the registry. - {{domxref("HighlightRegistry.entries()")}}
- : Returns a new iterator object that contains each
Highlightobject in the registry, in insertion order. - {{domxref("HighlightRegistry.forEach()")}}
- : Calls the given callback once for each
Highlightobject in the registry, in insertion order. - {{domxref("HighlightRegistry.get()")}}
- : Gets the named
Highlightobject from the registry. - {{domxref("HighlightRegistry.has()")}}
- : Returns a boolean asserting whether a
Highlightobject is present the registry or not. - {{domxref("HighlightRegistry.highlightsFromPoint()")}}
- : Returns an array of objects representing the custom highlights applied at a specific point within the viewport.
- {{domxref("HighlightRegistry.keys()")}}
- : An alias for {{domxref("HighlightRegistry.values()")}}.
- {{domxref("HighlightRegistry.set()")}}
- : Adds the given
Highlightobject to the registry with the given name, or updates the namedHighlightobject, if it already exists in the registry. - {{domxref("HighlightRegistry.values()")}}
- : Returns a new iterator object that yields the
Highlightobjects in the registry, in insertion order.
Examples
Registering a highlight
The following example demonstrates how to create ranges, instantiate a new Highlight object for them, and register the highlight using the HighlightRegistry, to style it on the page:
HTML
<p id="foo">CSS Custom Highlight API</p>CSS
::highlight(my-custom-highlight) {
background-color: peachpuff;
}JavaScript
const text = document.getElementById("foo").firstChild;
if (!CSS.highlights) {
text.textContent =
"The CSS Custom Highlight API is not supported in this browser!";
}
// Create a couple of ranges.
const range1 = new Range();
range1.setStart(text, 0);
range1.setEnd(text, 3);
const range2 = new Range();
range2.setStart(text, 21);
range2.setEnd(text, 24);
// Create a custom highlight for these ranges.
const highlight = new Highlight(range1, range2);
// Register the ranges in the HighlightRegistry.
CSS.highlights.set("my-custom-highlight", highlight);Result
{{ EmbedLiveSample("Registering a highlight") }}
Specifications
{{Specifications}}
Browser compatibility
{{Compat}}
See also
- {{domxref("css_custom_highlight_api", "The CSS Custom Highlight API", "", "nocode")}}
- CSS custom highlight API module
- CSS Custom Highlight API: The Future of Highlighting Text Ranges on the Web