Back to Content

CaretPosition

files/en-us/web/api/caretposition/index.md

latest1020 B
Original Source

{{APIRef("CSSOM view API")}}

The CaretPosition interface represents the caret position, an indicator for the text insertion point. You can get a CaretPosition using the {{domxref("Document.caretPositionFromPoint()")}} method.

Instance properties

This interface doesn't inherit any properties.

  • {{domxref("CaretPosition.offsetNode")}} {{ReadOnlyInline}}
    • : Returns a {{domxref("Node")}} containing the found node at the caret's position.
  • {{domxref("CaretPosition.offset")}} {{ReadOnlyInline}}
    • : Returns a long representing the offset of the selection in the caret position node. This will be the character offset in a text node or the selected child node's index in an element node.

Instance methods

  • {{domxref("CaretPosition.getClientRect")}}
    • : Returns the client rectangle for the caret range.

Specifications

{{Specifications}}

Browser compatibility

{{Compat}}

See also

  • {{domxref("Document.caretPositionFromPoint()")}}
  • {{domxref("Range")}}
  • {{domxref("Node")}}