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
parentNode
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 | Status | Comment |
---|---|---|
Selection API The definition of 'Selection.collapse()' in that specification. |
Working Draft | |
HTML Editing APIs The definition of 'Selection.collapse()' in that specification. |
Editor's Draft | Initial definition |
Browser compatibility
Feature | Chrome | Edge | Firefox (Gecko) | Internet Explorer | Opera | Safari (WebKit) |
---|---|---|---|---|---|---|
Basic support | (Yes) | (Yes) | (Yes) | 9.0 | (Yes) | (Yes) |
node parameter is nullable; offset parameter is optional |
(Yes) | ? | 55 (55) | ? | (Yes) | (Yes) |
Feature | Android | Edge | Firefox Mobile (Gecko) | IE Phone | Opera Mobile | Safari Mobile |
---|---|---|---|---|---|---|
Basic support | ? | (Yes) | (Yes) | ? | ? | (Yes) |
node parameter is nullable; offset parameter is optional |
? | ? | 55.0 (55) | ? | ? | (Yes) |
See also
Selection
, the interface it belongs to.
Document Tags and Contributors
Tags:
Contributors to this page:
chrisdavidmills,
RedHatter,
abbycar,
Sebastianz,
BenjamP,
fscholz,
teoli,
MHasan,
kscarfone,
Prachi_Dighe,
Kartik_Chadha,
Sheppy,
Geurtz,
Federico,
DR,
Rev,
Jonnyq
Last updated by:
chrisdavidmills,