HighlightRegistry: set() method

Baseline 2025
Newly available

Since June 2025, this feature works across the latest devices and browser versions. This feature might not work in older devices or 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® 2026 Language Specification
# sec-map.prototype.set

Browser compatibility

See also