Firefox Tomorrow

web api instance method

Highlight: add() method

View on MDN ↗

The add() method of the Highlight interface adds a new AbstractRange object to a highlight, to be styled using the CSS Custom Highlight API.

Highlight is a Set-like object, so this is similar to using add().

Syntax

add(range)

Parameters

Return value

The Highlight object, with the added range.

Examples

The code snippet below shows how to add two ranges to a new highlight object:

const highlight = new Highlight();

const range1 = new Range();
const range2 = new Range();

highlight.add(range1).add(range2);

console.log(highlight.size); // 2

Specifications

SpecificationsStandards references are available on the canonical MDN page.

Browser compatibility

Browser compatibilityCompatibility data is available on the canonical MDN page.

See also