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 July 2015.
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
js
collapse(node)
collapse(node, offset)
Parameters
node-
The caret location will be within this node. This value can also be set to
null— ifnullis specified, the method will behave likeSelection.removeAllRanges(), i.e., all ranges will be removed from the selection. offsetOptional-
The offset in
nodeto which the selection will be collapsed. If not specified, the default value0is used.
Return value
None (undefined).
Examples
js
// 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
| desktop | mobile | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
collapse
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Accepts
node parameter in any tree/shadow tree
|
|
|
|
|
|
|
|
|
|
|
|
|
node parameter is nullable
|
|
|
|
|
|
|
|
|
|
|
|
|
offset parameter is optional
|
|
|
|
|
|
|
|
|
|
|
|
|
Legend
Tip: you can click/tap on a cell for more information.
- Full support
- Full support
- No support
- No support