Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Provide an API for getting visible caret position in textarea/input element #10614

Open
siliu1 opened this issue Sep 11, 2024 · 1 comment
Open

Comments

@siliu1
Copy link

siliu1 commented Sep 11, 2024

What is the issue with the HTML Standard?

What problem are you trying to solve?

There is no existing API to get selection bounds when selection is inside textarea/input element.
This proposal is to introduce an API on textarea/input to return selection bounds.

What solutions exist today?

Unfortunately there isn't a greate way to handle this. As suggested in this w3c/csswg-drafts#10346 :

The solution today is to clone the textarea as a div, and copy its layout effecting computes styles (such as font, size, writing direction, borders)
over so that we can get a Range back from the div. With the Range we can get the boundingClientRect.

How would you solve it?

We can introduce a new getSelectionBoundingClientRect() API on textarea/input element:

partial interface HTMLTextAreaElement {
  [NewObject] DOMRect getSelectionBoundingClientRect();
}

partial interface HTMLInputElement {
  [NewObject] DOMRect getSelectionBoundingClientRect();
}

The API would return the bounding rect of current selection in textarea/input element. The bounding rect
is the caret rect if the selection is collapsed. If there is no selection in textarea/input, it would return empty rect.

The proposed API aligns with existing selection APIs on textarea/input element such as select(), selectionStart, selectionEnd, etc.

Additional information

This proposal is only scoped to textarea/input element. For other elements, the selection/range API can be used, which has a getBoundingClientRect method to get the bounding client rect.

@sanketj
Copy link
Member

sanketj commented Sep 11, 2024

cc: @keithamus

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

No branches or pull requests

2 participants