Skip to content

@keys: Improve documentation about logical keys#10963

Open
LeonMatthes wants to merge 2 commits intoslint-ui:masterfrom
LeonMatthes:lm/102-logical-keys-documentation
Open

@keys: Improve documentation about logical keys#10963
LeonMatthes wants to merge 2 commits intoslint-ui:masterfrom
LeonMatthes:lm/102-logical-keys-documentation

Conversation

@LeonMatthes
Copy link
Collaborator

We received a lot of feedback in issue #102 that this differentiation was
not immediately obvious before.

@LeonMatthes LeonMatthes enabled auto-merge (rebase) March 6, 2026 12:16
@tronical tronical disabled auto-merge March 6, 2026 13:44
Named keys inside `@keys(..)` are logical: `A` represents the character `a`, not a specific physical key location. This means `@keys(Control + A)` will activate on whichever key produces `a` on the user's layout, regardless of where that key sits on the keyboard.

The `@keys(..)` macro allows you to explicitly control this behavior for Advanced Keyboard shortcuts, if needed.
If the [`Key` namespace](#key-namespace) does not include the needed key, the @key macro also supports advanced keyboard shortcut definitions...
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Use contractions. That said: What's the trailing ...?

Suggested change
If the [`Key` namespace](#key-namespace) does not include the needed key, the @key macro also supports advanced keyboard shortcut definitions...
If the [`Key` namespace](#key-namespace) doesn't include the needed key, the `@key` macro also supports advanced keyboard shortcut definitions...

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

reworded

@LeonMatthes LeonMatthes enabled auto-merge (squash) March 6, 2026 13:49
@tronical
Copy link
Member

tronical commented Mar 6, 2026

Note the question about the trailing .... That seems ... not correct? :)

LeonMatthes and others added 2 commits March 9, 2026 09:22
We received a lot of feedback in issue slint-ui#102 that this differentiation was
not immediately obvious before.
Co-authored-by: Simon Hausmann <hausmann@gmail.com>
@LeonMatthes LeonMatthes force-pushed the lm/102-logical-keys-documentation branch from 1d68e0f to 624de88 Compare March 9, 2026 08:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants