W3cubDocs

/Web APIs

HighlightRegistry: delete() method

Experimental: This is an experimental technology
Check the Browser compatibility table carefully before using this in production.

The delete() method of the HighlightRegistry interface removes a the named Highlight object from the HighlightRegistry.

HighlightRegistry is a Map-like object, so this is similar to using Map.delete().

Syntax

js

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:

js

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

Desktop Mobile
Chrome Edge Firefox Internet Explorer Opera Safari WebView Android Chrome Android Firefox for Android Opera Android Safari on IOS Samsung Internet
delete 105 105 preview No 91 No 105 105 No 72 No 20.0

See also

© 2005–2023 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/HighlightRegistry/delete