✨ hardware cursor positioning via text() caret#103
Draft
cowboyd wants to merge 14 commits into
Draft
Conversation
commit: |
cowboyd
changed the title
cowboyd
force-pushed
the
cowboyd/text-caret
branch
2 times, most recently
from
cfc0338 to
4d7b8ca
Compare
Contributor
cowboyd
force-pushed
the
cowboyd/text-caret
branch
from
4d7b8ca to
9d23833
Compare
|
Size Increased — +0.4 KB 124.7 KB unpacked |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What does this PR do?
Adds a
caret?: numberproperty to thetext()directive. When declared, the renderer positions the terminal's native cursor at the code-point offset within the text and manages cursor visibility automatically across frames.Motivation: building a text input on top of the renderer requires the terminal cursor to track the insertion point and disappear when no input is focused. The cell where the caret sits depends on the text's layout and wrapping — information the renderer already has and the caller does not.
While painting a synthetic caret is always a possibility, the native caret is almost always going to be preferable.
Open questions
Clay emits no
CLAY_RENDER_COMMAND_TYPE_TEXTfor an empty string, sotext("", { caret: 0 })cannot resolve a cell and silently suppresses the cursor. Documented as a test that captures current behavior. The example works around this by rendering a single space when the field is empty — invisible against the input background, but the placeholder is not ideal. One possible fix is for the renderer to fall back to the caret's parent element's bounds, but unsure what the right call is.There are lurking edge cases around padding and fractional cell widths. Need to dive into those before merging.