Selection: 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 Selection.collapse()
method collapses the current selection to a single point. The document is not modified. If the content is focused and editable, the caret will blink there.
Note: This method is an alias for the Selection.setPosition()
method.
Syntax
collapse(node)
collapse(node, offset)
Parameters
node
-
The caret location will be within this node. This value can also be set to
null
— ifnull
is specified, the method will behave likeSelection.removeAllRanges()
, i.e. all ranges will be removed from the selection. offset
Optional-
The offset in
node
to which the selection will be collapsed. If not specified, the default value0
is used.
Return value
None (undefined
).
Examples
// Place the caret at the beginning of an HTML document's body.
const body = document.querySelector("body");
window.getSelection().collapse(body, 0);
Specifications
Specification |
---|
Selection API # dom-selection-collapse |
Browser compatibility
BCD tables only load in the browser