Range: collapse() method
Baseline Widely available
This feature is well established and works across many devices and browser versions. It’s been available across browsers since March 2017.
The Range.collapse()
method collapses the
Range
to one of its boundary points.
A collapsed Range
is empty, containing no content, specifying a
single-point in a DOM tree. To determine if a Range
is already collapsed,
see the Range.collapsed
property.
Syntax
js
collapse()
collapse(toStart)
Parameters
toStart
Optional-
A boolean value:
true
collapses theRange
to its start,false
to its end. If omitted, it defaults tofalse
Experimental .
Return value
None (undefined
).
Examples
js
const range = document.createRange();
const referenceNode = document.getElementsByTagName("div").item(0);
range.selectNode(referenceNode);
range.collapse(true);
Specifications
Specification |
---|
DOM Standard # dom-range-collapse |
Browser compatibility
BCD tables only load in the browser