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

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 This is an experimental API that should not be used in production code. .

Example

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.
Obsolete Initial specification.

Browser compatibility

BCD tables only load in the browser

See also