This is an experimental technologyCheck 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 | Status | Comment |
Selection APIThe definition of 'Selection.collapse()' in that specification. | Working Draft |
Browser compatibility
The compatibility table on this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.
Update compatibility data on GitHub
Desktop | Mobile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Chrome
Full support Yes |
Edge
Full support 12 |
Firefox
Full support Yes |
IE
Full support 9 |
Opera
Full support Yes |
Safari
Full support Yes |
WebView Android
Full support Yes |
Chrome Android
Full support Yes |
Firefox Android
Full support Yes |
Opera Android
Full support Yes |
Safari iOS
Full support Yes |
Samsung Internet Android
Full support Yes |
Legend
- Full support
- Full support
- Experimental. Expect behavior to change in the future.'
- Experimental. Expect behavior to change in the future.
See also
Selection
, the interface it belongs to.
Selection.collapse() by Mozilla Contributors is licensed under CC-BY-SA 2.5.