HighlightRegistry: set() method

Limited availability

This feature is not Baseline because it does not work in some of the most widely-used browsers.

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

Specification
ECMAScript® 2025 Language Specification
# sec-map.prototype.set

Browser compatibility

Report problems with this compatibility data on GitHub
desktopmobile
Chrome
Edge
Firefox
Opera
Safari
Chrome Android
Firefox for Android
Opera Android
Safari on iOS
Samsung Internet
WebView Android
WebView on iOS
set

Legend

Tip: you can click/tap on a cell for more information.

Full support
Full support
In development. Supported in a pre-release version.
In development. Supported in a pre-release version.
No support
No support
See implementation notes.

See also