HighlightRegistry: get() method

Limited availability

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

The get() method of the HighlightRegistry interface returns the named Highlight object from the registry.

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

Syntax

js
get(name)

Parameters

name

The name of the Highlight object to return from the registry. The name must be a String.

Return value

The Highlight object associated with the specified name, or undefined if the name can't be found in the HighlightRegistry.

Examples

The following code sample demonstrates how to create a new Highlight, add it to the registry, and retrieve it by its name using the get() method:

js
const fooHighlight = new Highlight();
CSS.highlights.set("foo", fooHighlight);

console.log(CSS.highlights.get("foo")); // Returns the fooHighlight object.

Specifications

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

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
get

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