HighlightRegistry: set() method

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

The set() method of the {{domxref("HighlightRegistry")}}  interface adds or updates a {{domxref("Highlight")}}  object in the registry with the specified name.

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

Syntax

set(name, highlight)

Parameters

• name
  • : The name of the Highlight object to add or update. The name must be a {{jsxref("String")}} .
• highlight
  • : The Highlight object to add or update. This must be a {{domxref("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 back 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

{{Specifications}} 

Browser compatibility

{{Compat}} 

See also

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