Selection: collapse() Methode

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.

Die Selection.collapse() Methode reduziert die aktuelle Auswahl auf einen einzigen Punkt. Das Dokument wird nicht verändert. Wenn der Inhalt fokussiert und bearbeitbar ist, wird der Cursor dort blinken.

Hinweis: Diese Methode ist ein Alias für die Selection.setPosition() Methode.

Syntax

js
collapse(node)
collapse(node, offset)

Parameter

node

Der Cursor wird innerhalb dieses Knotens positioniert. Dieser Wert kann auch auf null gesetzt werden — wenn null angegeben ist, verhält sich die Methode wie Selection.removeAllRanges(), d.h. alle Bereiche werden aus der Auswahl entfernt.

offset Optional

Der Versatz in node, zu dem die Auswahl reduziert wird. Wenn nicht angegeben, wird der Standardwert 0 verwendet.

Rückgabewert

Keiner (undefined).

Beispiele

js
// Place the caret at the beginning of an HTML document's body.
const body = document.querySelector("body");
window.getSelection().collapse(body, 0);

Spezifikationen

Specification
Selection API
# dom-selection-collapse

Browser-Kompatibilität

Siehe auch