ContextQMD
Back to Content

Range: collapse() method

files/en-us/web/api/range/collapse/index.md

latest1.0 KB
Original Source

{{APIRef("DOM")}}

The collapse() method of the {{domxref("Range")}} interface collapses the {{domxref("Range")}} to one of its boundary points.

A collapsed {{domxref("Range")}} is empty, containing no content, specifying a single-point in a DOM tree. To determine if a {{domxref("Range")}} is already collapsed, see the {{domxref("AbstractRange.collapsed")}} property.

Syntax

js-nolint
collapse()
collapse(toStart)

Parameters

  • toStart {{optional_inline}}
    • : A boolean value: true collapses the {{domxref("Range")}} to its start, false to its end. If omitted, it defaults to false.

Return value

None ({{jsxref("undefined")}}).

Examples

js
const range = document.createRange();

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

Specifications

{{Specifications}}

Browser compatibility

{{Compat}}

See also