W3cubDocs

/Web APIs

HighlightRegistry: set() method

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

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

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

Syntax

js

set(name, highlight)

Parameters

name

The name of the Highlight object to add or update. The name must be a String.

highlight

The Highlight object to add or update. This must be a Highlight interface instance.

Return value

The HighlightRegistry object.

Examples

Using set()

js

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:

js

const fooHighlight = new Highlight();
const barHighlight = new Highlight();
const bazHighlight = new Highlight();

CSS.highlights
  .set("foo", fooHighlight)
  .set("bar", barHighlight)
  .set("baz", bazHighlight);

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
set 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/set