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 theHighlight
.
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
Specification |
---|
ECMAScript Language Specification # sec-set.prototype.add |
Browser compatibility
BCD tables only load in the browser