HighlightRegistry: clear() method
Baseline 2025Newly available
Since June 2025, this feature works across the latest devices and browser versions. This feature might not work in older devices or browsers.
The clear() method of the HighlightRegistry interface removes all the Highlight objects registered in the HighlightRegistry.
HighlightRegistry is a Map-like object, so this is similar to using Map.clear().
Syntax
js
clear()
Parameters
None.
Return value
None (undefined).
Examples
The code snippet below registers two highlight objects in the registry and then clears the registry:
js
const customHighlight1 = new Highlight(range1, range2);
const customHighlight2 = new Highlight(range3, range4, range5);
CSS.highlights.set("custom-highlight-1", customHighlight1);
CSS.highlights.set("custom-highlight-2", customHighlight2);
console.log(CSS.highlights.size); // 2
CSS.highlights.clear();
console.log(CSS.highlights.size); // 0
Specifications
| Specification |
|---|
| ECMAScript® 2026 Language Specification # sec-map.prototype.clear |