HighlightRegistry: delete() method

فهرست فصل‌ها دانلود آرشیوناشر

MDN Web Docs · نسخهٔ df622a2a1c1e · CC BY-SA 2.5 و مجوز جداگانهٔ ناشر برای نمونه‌کد

{{APIRef("CSS Custom Highlight API")}}

The **delete()** method of the {{domxref("HighlightRegistry")}} interface removes the named {{domxref("Highlight")}} object from the HighlightRegistry.

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

Syntax

js-nolint
delete(customHighlightName)

Parameters

  • customHighlightName
  • : The name, as a {{jsxref("String")}}, of the {{domxref("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

{{Specifications}}

Browser compatibility

{{Compat}}

See also

  • {{domxref("css_custom_highlight_api", "The CSS Custom Highlight API", "", "nocode")}}
  • CSS Custom Highlight API: The Future of Highlighting Text Ranges on the Web