Range.collapse()

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

JavaScript
range.collapse(toStart);

Parameters

toStart Optional
A boolean value: true collapses the Range to its start, false to its end. If omitted, it defaults to false .

Example

JavaScript
var range = document.createRange();

referenceNode = document.getElementsByTagName("div").item(0);
range.selectNode(referenceNode);
range.collapse(true);

Specifications

Specification Status Comment
DOM
The definition of 'Range.collapse()' in that specification.
Living Standard The parameter is now optional and default to false.
Document Object Model (DOM) Level 2 Traversal and Range Specification
The definition of 'Range.collapse()' in that specification.
Recommendation Initial specification.

Browser compatibility

Feature Chrome Firefox (Gecko) Internet Explorer Opera Safari
Basic support (Yes) 1.0 (1.7 or earlier) 9.0 9.0 (Yes)
Parameter optional (Yes) 25 (25) Not supported[1] 15.0 (Yes)
Feature Android Firefox Mobile (Gecko) IE Mobile Opera Mobile Safari Mobile
Basic support (Yes) 1.0 (1.0) 9.0 9.0 (Yes)
Parameter optional (Yes) 25 (25) Not supported[1] 15.0 (Yes)

[1] Optional but defaults to true.

See also

License

© 2016 Mozilla Contributors
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-us/docs/web/api/range/collapse

API DOM Method Range