CSS Custom Highlight API
The forEach() method of the Highlight interface executes a provided function once for each AbstractRange object in the Highlight object, in insertion order.
Highlight is a Set-like object, so this is similar to using Set.forEach().
Syntax
forEach(callbackFn)
forEach(callbackFn, thisArg)
Parameters
-
callback- : Function to execute for each
AbstractRangeobject, taking three arguments:range,key- : The current
AbstractRangeobject being processed in theHighlight. As there are no keys inHighlight, therangeis passed for both arguments.
- : The current
highlight- : The
Highlightobject whichforEach()was called upon.
- : The
- : Function to execute for each
-
thisArg- : Value to use as
thiswhen executingcallbackFn.
- : Value to use as
Return value
None (undefined).
Examples
The code snippet below shows how to create a new highlight with two ranges, and then log the ranges by using the forEach() method:
function logRanges(range, key, highlight) {
console.log(`Highlight object ${highlight} contains range ${range}`);
}
const text = new Text("Time is an illusion. Lunchtime doubly so.");
const range1 = document.createRange();
range1.setStart(text, 0);
range1.setEnd(text, 4);
const range2 = document.createRange();
range2.setStart(text, 21);
range2.setEnd(text, 30);
const myHighlight = new Highlight();
myHighlight.add(range1);
myHighlight.add(range2);
myHighlight.forEach(logRanges);
Specifications
Browser compatibility
See also
- css_custom_highlight_api
- CSS Custom Highlight API: The Future of Highlighting Text Ranges on the Web
来源:MDN Web Docs / Mozilla 贡献者 · 作者与贡献记录 · CC BY-SA 2.5。离线整理了版式、链接和媒体显示。
