W3cubDocs

/Web APIs

Document: caretRangeFromPoint() method

Non-standard: This feature is non-standard and is not on a standards track. Do not use it on production sites facing the Web: it will not work for every user. There may also be large incompatibilities between implementations and the behavior may change in the future.

The caretRangeFromPoint() method of the Document interface returns a Range object for the document fragment under the specified coordinates.

This method is the WebKit-proprietary implementation of the Document.caretPositionFromPoint method.

Syntax

js

caretRangeFromPoint(x, y)

Parameters

x

A horizontal position within the current viewport.

y

A vertical position within the current viewport.

Return value

One of the following:

  • A Range.
  • Null, if x or y are negative, outside viewport, or there is no text entry node.

Examples

Visit the Document.caretPositionFromPoint page to view a live sample of this method.

Browser compatibility

Desktop Mobile
Chrome Edge Firefox Internet Explorer Opera Safari WebView Android Chrome Android Firefox for Android Opera Android Safari on IOS Samsung Internet
caretRangeFromPoint 4 12 No No 15 5 ≤37 18 No 14 4 1.0

© 2005–2023 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/Document/caretRangeFromPoint