W3cubDocs

/Web APIs

Highlight: add() method

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

The add() method of the Highlight interface adds a new Range 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 Set.add().

Syntax

js

add(range)

Parameters

range

A Range object to add to the Highlight.

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:

js

const highlight = new Highlight();

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

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

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

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
add 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/Highlight/add