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 — if null is specified, the method will behave like Selection.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 value 0 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

BCD tables only load in the browser

See also