Selection.collapse()
Experimental: This is an experimental technology
Check the Browser compatibility table carefully before using this in production.
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.
Syntax
sel.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.
Examples
/* Place the caret at the beginning of an HTML document's body. */ var body = document.getElementsByTagName("body")[0]; window.getSelection().collapse(body,0);
Specifications
Specification |
---|
Selection API # dom-selection-collapse |
Browser compatibility
Desktop | Mobile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Chrome | Edge | Firefox | Internet Explorer | Opera | Safari | WebView Android | Chrome Android | Firefox for Android | Opera Android | Safari on IOS | Samsung Internet | |
collapse |
1 |
12 |
1 |
9 |
≤12.1 |
1.3 |
1 |
18 |
4 |
≤12.1 |
1 |
1.0 |
node_parameter_nullable |
Yes |
≤79 |
55 |
No |
Yes |
Yes |
Yes |
Yes |
55 |
Yes |
Yes |
Yes |
offset_parameter_optional |
Yes |
≤79 |
55 |
No |
Yes |
Yes |
Yes |
Yes |
55 |
Yes |
Yes |
Yes |
See also
-
Selection
, the interface it belongs to.
© 2005–2021 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/Selection/collapse