Property 'caretPositionFromPoint' does not exist on type 'Document'

[Egor-Koldasov]

Bug Report

🔎 Search Terms

caretPositionFromPoint
Property 'caretPositionFromPoint' does not exist on type 'Document'

🕗 Version & Regression Information

• This changed between versions 4.3.5 and 4.4.2

⏯ Playground Link

Doesn't work in 4.4.4: Playground link
Works in 4.3.5: Playground link

💻 Code

if (document.caretPositionFromPoint) document.caretPositionFromPoint(0, 0);

🙁 Actual behavior

'Document' should have an optional property "caretPositionFromPoint" since it exists in Firefox browser. Link.

🙂 Expected behavior

Property "caretPositionFromPoint" has been removed from 'Document', I was not able to find an explanation of this decision.

[MartinJohns]

It was removed here: microsoft/TypeScript-DOM-lib-generator#1029

Probably because it's an experimental API with close to no browser support: https://developer.mozilla.org/en-US/docs/Web/API/Document/caretPositionFromPoint

[typescript-bot]

This issue has been marked 'Working as Intended' and has seen no recent activity. It has been automatically closed for house-keeping purposes.

[mike-lischke]

Still the wrong decision IMO. The alternative document.caretRangeFromPoint is deprecated and without document.caretPositionFromPoint there's no alternative to use. The variant document.caretPositionFromPoint works in Firefox and web devs need to test for it either to use this or the alternative. How are we supposed to do that, if there's no entry for the method we need to test?

[mgiraldo]

i'm in this exact situation. i need to support either method for the different browsers that support them... kind of:

let range;

if (document.caretRangeFromPoint) {
  range = document.caretRangeFromPoint(x, y)
} else {
  range = document.caretPositionFromPoint(x, y)
}

is there a shim i can add to have Document include caretPositionFromPoint?

[raphael10-collab]

I totally agree with @mike-lischke

We need the type-support for both caretPositionFromPoint and caretRangeFromPoint : https://developer.mozilla.org/en-US/docs/Web/API/Document/caretPositionFromPoint#examples

[vogon]

#49931 (comment) it's been a year since you left this comment, so hopefully you got some help elsewhere by now, but for anyone else who wants a quick shim for this, here's what I'm using:

declare global {
    type CaretPosition = {
        offsetNode: Node;
        offset: number;
    }

    interface Document {
        caretPositionFromPoint?(x: number, y: number): CaretPosition;
    }
}

it doesn't support getClientRect() on CaretPosition, but that wasn't necessary for our use case and hopefully it should be straightforward enough to figure out its declaration if it is for yours.