HighlightRegistry: set() method
CSS Custom Highlight API
CSS Custom Highlight API
The set() method of the HighlightRegistry interface adds or updates a Highlight object in the registry with the specified name.
HighlightRegistry is a Map-like object, so this is similar to using Map.set().
Syntax
set(name, highlight)
Parameters
name- : The name of the
Highlightobject to add or update. The name must be a String. highlight- : The
Highlightobject to add or update. This must be a Highlight interface instance.
Return value
The HighlightRegistry object.
Examples
Using set()
const fooHighlight = new Highlight();
CSS.highlights.set("foo", fooHighlight);
Using set() with chaining
Since the set() method returns the registry, you can chain the method call like below:
const fooHighlight = new Highlight();
const barHighlight = new Highlight();
const bazHighlight = new Highlight();
CSS.highlights
.set("foo", fooHighlight)
.set("bar", barHighlight)
.set("baz", bazHighlight);
Specifications
Browser compatibility
See also
- The CSS Custom Highlight API
- CSS custom highlight API module
- CSS Custom Highlight API: The Future of Highlighting Text Ranges on the Web