Accept individual modifier keys as valid keybindings #637

g547315 · 2023-09-25T11:25:02Z

References

Trigger functionalities on key down and key up of Alt or Alt + Shift

Code changes

Allow the key down event listener to return a mod key or combination of mods to be processed and matched to its keybinding and the keyboard shortcut associated with it

Tests have been changed to reflect the new functionality of mod keys. As mod keys now have additional functionality, pressing a mod key will break the sequence when entering a key sequence i.e. [Shift K, Shift L]. The test 'should ignore modifier keys pressed in the middle of key sequence' has been changed to reflect this. A similar change has been made to 'should process key sequences that use different modifier keys' to remove unnecessary keystrokes.

'should return nothing for keys that are marked as modifier in keyboard layout' has been modified as mod keys now return keyboard events.

To see the full interned functionality please combine this PR with:

Added and styled overlay UI element #633

User-facing changes

None

Backwards-incompatible changes

None

g547315 · 2023-09-25T15:00:05Z

@krassowski
@tonyfast
@brichet

brichet

Thanks for working on this @g547315.

I have some comments below.

Would it be possible to wait for a delay before returning the modifier keys combination (when there are only modifier keys pressed) ?
That could avoid triggering the event linked to that modifier key, while only using the modifier in a shortcut.

packages/commands/src/index.ts

tonyfast · 2023-09-28T18:18:39Z

should these modify combinations be configurable?

g547315 · 2023-10-03T15:52:32Z

should these modify combinations be configurable?

could you elaborate please
@tonyfast

tonyfast · 2023-10-03T15:57:20Z

should these modify combinations be configurable?

modifier keys for assistive technology vary with locale, operating system, and vendor. there might be edge cases where this specific modifier combination is challenge for certain users. the most assistive solution would allow for configurable modifier key codes with Alt + Shift as the default.

…g547315/lumino into allow-mapping-to-mod-keys

krassowski · 2023-12-14T15:59:27Z

The failure is relevant:

Run for file in review/api/application.api.md review/api/commands.api.md; do
review/api/application.api.md
review/api/commands.api.md

Needs running yarn run api and committing changes

packages/commands/src/index.ts

Co-authored-by: Nicolas Brichet <32258950+brichet@users.noreply.github.com>

g547315 · 2023-12-14T16:59:25Z

@brichet Thanks for the second pair of eyes and the contributions to the PR.
Having tested the code change via my dev environment and this binder link Link (Please click the launch binder button) I can't seem to consistently see the intended functionality.

Mod keys bindings are being detected and matched, however they are not executed consistently or at all

Please note the binder instance has styled overlay UI element that should be displayed when Mod keys bindings are executed

brichet · 2023-12-14T17:58:00Z

@brichet Thanks for the second pair of eyes and the contributions to the PR. Having tested the code change via my dev environment and this binder link Link (Please click the launch binder button) I can't seem to consistently see the intended functionality.

Mod keys bindings are being detected and matched, however they are not executed consistently or at all

Please note the binder instance has styled overlay UI element that should be displayed when Mod keys bindings are executed

This is nice for testing @g547315.

It works well on my side, when holding the key for 1s (it currently uses the CHORD_TIMEOUT variable).

Let's create a new variable with a shorter delay for this feature.

g547315 · 2023-12-15T14:53:15Z

@brichet Thanks for the second pair of eyes and the contributions to the PR. Having tested the code change via my dev environment and this binder link Link (Please click the launch binder button) I can't seem to consistently see the intended functionality.
Mod keys bindings are being detected and matched, however they are not executed consistently or at all

Please note the binder instance has styled overlay UI element that should be displayed when Mod keys bindings are executed

This is nice for testing @g547315.

It works well on my side, when holding the key for 1s (it currently uses the CHORD_TIMEOUT variable).

Let's create a new variable with a shorter delay for this feature.

New variable added and set to 500ms

…g547315/lumino into allow-mapping-to-mod-keys

review/api/widgets.api.md

g547315 · 2024-03-28T10:59:58Z

This pull request should to be ready for merging. However, I am unable to continue working on it after March 28, 2024. If further refinements are identified, I welcome any future contributors to pick up and progress the work

brichet · 2024-03-28T12:46:11Z

Thanks again @g547315 for working on this.

Since I worked on it, it would be nice to have another opinion before merging.
@krassowski do you think we can merge this PR ?

krassowski · 2024-03-30T09:19:14Z

packages/commands/src/index.ts

+        this._startModifierTimer(exact);
+      } else {
+        // Otherwise stop potential existing timer.
+        this._clearModifierTimer();


Thanks for the ping @brichet!

Should the modifier timer also be stopped if an exact match for a chord is found?

For example if the sequence is Ctrl Z (not Ctrl + Z but Ctrl followed by Z) we would get two events (one for Ctrl, one for Z). My impression from just reading the code (I could be wrong) is that currently it would trigger both the handler for Ctrl and for the Ctrl followed by Z chord.

In other words, should _clearModifierTimer be called in _clearPendingState too?

You are right, but this behavior seems OK if this feature is only used to display overlays.
You may want to keep the modifier key(s) pressed (and the overlays visible) to trigger another shortcut.

If we keep it that way, we should probably document it somewhere, to avoid using this modifier key(s) for unexpected action.

You may want to keep the modifier key(s) pressed (and the overlays visible) to trigger another shortcut.

Yes, but I also do not want to have the overlay visible ("sticky") after I already pressed the combo I was interested in. I think if user is pressing two shortcuts and they need overlays, say Ctrl + C and Ctrl + V it is fine it they do that in sequence:

Ctrl: shows overlay

Ctrl + C: overlay hides immediately

Ctrl: shows overlay again

Ctrl + V: overlay hides immediately again

Actually, the overlay visible or not depends on the command that will be triggered.
Here it is only about the timeout before triggering the command, so you're right we better clear it if an other command is triggered. BTW the timeout is also cleared on key up event with this PR.
I updated it.

krassowski

Thank you!

extend keystrokes to mod keys

c82fc4a

github-actions bot assigned g547315 Sep 25, 2023

This was referenced Sep 12, 2023

Add overlay UI element to display Jupyter tab bar keyboard shortcut number jupyterlab/jupyterlab#15090

Open

Create, display and show shortcut number in overlay jupyterlab/jupyterlab#15155

Open

brichet reviewed Sep 27, 2023

View reviewed changes

packages/commands/src/index.ts Outdated Show resolved Hide resolved

packages/commands/src/index.ts Outdated Show resolved Hide resolved

packages/commands/src/index.ts Show resolved Hide resolved

g547315 added 2 commits October 3, 2023 15:09

fix doubled keys

835f745

remove comments

b9d2db3

g547315 requested a review from brichet October 3, 2023 15:52

g547315 mentioned this pull request Oct 3, 2023

Add overlay UI element #633

Closed

g547315 and others added 17 commits October 4, 2023 09:52

remove console-log

12f6921

Merge branch 'jupyterlab:main' into allow-mapping-to-mod-keys

77330ad

Removed whitespace from keystrokes

6cfdf12

Run prettier

2167496

Updated normalizeKeystroke to account for empty string

d9ddb6c

Check for empty string in key

4efbfc7

Check for empty string

5e5e65c

Checking for whitespace

d4e384c

Trim whitespace

36fcbad

Added check for keys

d520616

refactor add space for puley modifier key

4926fd0

Changed tests to reflect mod keys creating events

9bf4c47

Changed tests to match key bindings

85a1362

Revert test changes

5ed4103

remove added white space

d9a3f6f

Merge branch 'jupyterlab:main' into allow-mapping-to-mod-keys

3ebd720

Merge branch 'allow-mapping-to-mod-keys' of ssh://ssh.github.com:443/…

ab4c7bf

…g547315/lumino into allow-mapping-to-mod-keys

brichet reviewed Dec 14, 2023

View reviewed changes

packages/commands/src/index.ts Outdated Show resolved Hide resolved

Update packages/commands/src/index.ts

088a379

Co-authored-by: Nicolas Brichet <32258950+brichet@users.noreply.github.com>

g547315 added 4 commits December 15, 2023 14:53

added new variable with a shorter delay

d670fce

Merge branch 'allow-mapping-to-mod-keys' of ssh://ssh.github.com:443/…

7d385f6

…g547315/lumino into allow-mapping-to-mod-keys

ran yarn run api and committing changes

57d8170

ran linter

b3c4237

g547315 requested a review from brichet December 15, 2023 15:10

g547315 closed this Dec 15, 2023

g547315 reopened this Dec 15, 2023

brichet reviewed Dec 15, 2023

View reviewed changes

review/api/widgets.api.md Outdated Show resolved Hide resolved

brichet approved these changes Dec 18, 2023

View reviewed changes

g547315 requested a review from krassowski January 5, 2024 12:44

m158261 mentioned this pull request Jan 11, 2024

JupyterLab/Lumino Accessibility Demo Branches t03857785/jupyterlab#12

Open

g547315 added 2 commits March 11, 2024 14:50

refactor variable to camelcase

aef9685

refactor variable to camelcase

1873564

g547315 force-pushed the allow-mapping-to-mod-keys branch from 2a84063 to 1873564 Compare March 12, 2024 10:20

g547315 added 2 commits March 13, 2024 09:37

updated api

4b67ed0

Merge branch 'main' into allow-mapping-to-mod-keys

c8b1f39

krassowski reviewed Mar 30, 2024

View reviewed changes

krassowski changed the title ~~extend keystrokes to mod keys~~ Accept individual modifier keys as valid keybindings Mar 30, 2024

Clear modifier timeout if an exact match is found

73873be

krassowski approved these changes Apr 4, 2024

View reviewed changes

krassowski merged commit ededf7f into jupyterlab:main Apr 4, 2024
17 checks passed

fcollonval mentioned this pull request Jun 28, 2024

Bump versions and fix yarn installation in CI #711

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Accept individual modifier keys as valid keybindings #637

Accept individual modifier keys as valid keybindings #637

g547315 commented Sep 25, 2023 •

edited

Loading

g547315 commented Sep 25, 2023

brichet left a comment

tonyfast commented Sep 28, 2023

g547315 commented Oct 3, 2023

tonyfast commented Oct 3, 2023

krassowski commented Dec 14, 2023

g547315 commented Dec 14, 2023 •

edited

Loading

brichet commented Dec 14, 2023

g547315 commented Dec 15, 2023

g547315 commented Mar 28, 2024

brichet commented Mar 28, 2024

krassowski Mar 30, 2024

brichet Apr 3, 2024 •

edited

Loading

krassowski Apr 4, 2024

brichet Apr 4, 2024 •

edited

Loading

krassowski left a comment

Accept individual modifier keys as valid keybindings #637

Accept individual modifier keys as valid keybindings #637

Conversation

g547315 commented Sep 25, 2023 • edited Loading

References

Code changes

User-facing changes

Backwards-incompatible changes

g547315 commented Sep 25, 2023

brichet left a comment

Choose a reason for hiding this comment

tonyfast commented Sep 28, 2023

g547315 commented Oct 3, 2023

tonyfast commented Oct 3, 2023

krassowski commented Dec 14, 2023

g547315 commented Dec 14, 2023 • edited Loading

brichet commented Dec 14, 2023

g547315 commented Dec 15, 2023

g547315 commented Mar 28, 2024

brichet commented Mar 28, 2024

krassowski Mar 30, 2024

Choose a reason for hiding this comment

brichet Apr 3, 2024 • edited Loading

Choose a reason for hiding this comment

krassowski Apr 4, 2024

Choose a reason for hiding this comment

brichet Apr 4, 2024 • edited Loading

Choose a reason for hiding this comment

krassowski left a comment

Choose a reason for hiding this comment

g547315 commented Sep 25, 2023 •

edited

Loading

g547315 commented Dec 14, 2023 •

edited

Loading

brichet Apr 3, 2024 •

edited

Loading

brichet Apr 4, 2024 •

edited

Loading