HighlightRegistry: delete() method
CSS Custom Highlight API
CSS Custom Highlight API
The delete() method of the HighlightRegistry interface removes the named Highlight object from the HighlightRegistry.
HighlightRegistry is a Map-like object, so this is similar to using Map.delete().
Syntax
delete(customHighlightName)
Parameters
customHighlightName- : The name, as a String, of the Highlight object to remove from the
HighlightRegistry.
Return value
Returns true if a Highlight object under the provided name was in the HighlightRegistry; otherwise false.
Examples
The following code sample registers a highlight in the registry, and then deletes it:
const myHighlight = new Highlight(range1, range2);
CSS.highlights.set("my-highlight", myHighlight);
CSS.highlights.delete("foo"); // false
CSS.highlights.delete("my-highlight"); // true
Specifications
Browser compatibility
See also
- The CSS Custom Highlight API
- CSS Custom Highlight API: The Future of Highlighting Text Ranges on the Web