feat(web): implement `doModifierPress` ✨ 🎼 by ermshiperete · Pull Request #15343 · keymanapp/keyman

ermshiperete · 2025-12-11T17:57:19Z

Fixes: #15287
Test-bot: skip

keymanapp-test-bot · 2025-12-11T17:57:23Z

User Test Results

Test specification and instructions

User tests are not required

Fixes: #15287 Test-bot: skip

mcdurdin

I am not sure about some of the modifier-related changes here, we should discuss

mcdurdin · 2025-12-22T05:35:33Z

web/src/engine/src/core-processor/coreKeyboardProcessor.ts

+    if (this.activeKeyboard.isMnemonic && this.stateKeys['K_CAPS'] && (!e || !e.isModifier)) {
+      // Modifier keypresses don't trigger mnemonic manipulation of modifier state.
+      // Only an output key does; active use of Caps will also flip the SHIFT flag.
+      // Mnemonic keystrokes manipulate the SHIFT property based on CAPS state.
+      // We need to unflip them when tracking the OSK layer.
+      keyShiftState ^= ModifierKeyConstants.K_SHIFTFLAG;
+    }


Is this straight from jsKeyboardProcessor? I just don't quite understand the rationale - shift and caps have different effects on keys (e.g. 1 --> ! / 1 vs a --> A / A for shift and caps respectively)

Yes, that's from jsKeyboardProcessor:

keyman/web/src/engine/src/js-processor/jsKeyboardProcessor.ts

Line 303 in 68de61a

if(this.activeKeyboard.isMnemonic && this.stateKeys['K_CAPS']) {

Worth reading through the PR and comments that originally added this: #5456

It looks like that code might not be correct - see #15439.

mcdurdin · 2025-12-22T05:38:43Z

web/src/engine/src/keyboard/keyEvent.ts

+      case Codes.keyCodes.K_RCTRL:
+      case Codes.keyCodes.K_LALT:
+      case Codes.keyCodes.K_RALT:
+      case Codes.keyCodes.K_ALTGR:


This is not a real AltGr. It's a pseudo AltGr that probably should never be used. See its keyCodes value of 50010. May need some further investigation!

Suggested change

case Codes.keyCodes.K_ALTGR:

Does this apply to all keycodes > 50000? If so, what are those? And we should probably add a comment to https://github.com/keymanapp/keyman/blob/feat/web/15287_doModifierPress/common/web/types/src/consts/virtual-key-constants.ts#L130

Yes, all the keycodes > 50000 are special key codes used only in touch layouts; called TKeymanWebTouchStandardKey in keymanweb-key-codes.ts (in the kmw compiler, translated from Delphi, hence the initial T):

keyman/developer/src/kmc-kmn/src/kmw-compiler/keymanweb-key-codes.ts

Lines 808 to 822 in 90f5ab6

export const enum

TKeymanWebTouchStandardKey {

K_LOPT = 50001,

K_ROPT = 50002,

K_NUMERALS = 50003,

K_SYMBOLS = 50004,

K_CURRENCIES = 50005,

K_UPPER = 50006,

K_LOWER = 50007,

K_ALPHA = 50008,

K_SHIFTED = 50009,

K_ALTGR = 50010,

K_TABBACK = 50011,

K_TABFWD = 50012

};

These are predefined to have specific behaviours on a touch layout but no effect on a standard layout. The documentation could be improved; see:

keyman/developer/docs/help/reference/file-types/keyman-touch-layout.md

Lines 106 to 141 in 929b7d7

As noted above, some `K_xxxx` codes emit characters, if no rule is defined.

There are also some codes which have special functions:

<table class="display">

<thead>

<tr>

<th>Identifier</th>

<th>Meaning</th>

</tr>

</thead>

<tbody>

<tr>

<td markdown="1">`K_ENTER`</td>

<td>Submit a form, or add a new line (multi-line); the key action may vary depending on the situation.</td>

</tr>

<tr>

<td markdown="1">`K_BKSP`</td>

<td>Delete back a single character. This key, if held down, will repeat. It is the only key code which triggers

repeat behavior.</td>

</tr>

<tr>

<td markdown="1">`K_LOPT`</td>

<td>Open the language menu (aka Globe key).</td>

</tr>

<tr>

<td markdown="1">`K_ROPT`</td>

<td>Hide the on screen keyboard.</td>

</tr>

<tr>

<td markdown="1">`K_TAB`, `K_TABBACK`, `K_TABFWD`</td>

<td markdown="1">Move to next or previous element in a form. Note that these key functions are normally

implemented outside the touch layout, so should not typically be used. `K_TAB` will go to previous

element if used with the `shift` modifier.</td>

</tr>

</tbody>

</table>

I added a comment to virtual-key-constants.ts

mcdurdin · 2025-12-22T05:39:37Z

web/src/engine/src/keyboard/keyEvent.ts

+      case Codes.keyCodes.K_LSHIFT:
+      case Codes.keyCodes.K_RSHIFT:
+      case Codes.keyCodes.K_LCTRL:
+      case Codes.keyCodes.K_RCTRL:
+      case Codes.keyCodes.K_LALT:
+      case Codes.keyCodes.K_RALT:


These do not currently return true, so this is a functional change which would need extensive testing. I suggest we do not add them here unless we actually have a need for them, or else we audit all uses to ensure that adding these does not break anything.

mcdurdin · 2025-12-22T05:50:44Z

web/src/test/auto/headless/engine/core-processor/coreKeyboardProcessor.tests.ts

+      { code: Codes.keyCodes.K_NUMLOCK, name: 'NumLock' },
+      { code: Codes.keyCodes.K_SCROLL, name: 'ScrollLock' },
+      // TODO-web-core: should LSHIFT/RSHIFT etc also be detected as modifier?
+      // Currently .js keyboards don't don't support distinguishing


.js keyboards do support L/R alt and ctrl, but not L/R shift. We don't support L/R shift anywhere in Keyman.

Build-bot: skip Test-bot: skip

…feat/web/15287_doModifierPress

mcdurdin · 2026-01-22T05:10:47Z

web/src/engine/src/core-processor/coreKeyboardProcessor.ts

+    const lockNames  = ['CAPS', 'NUM_LOCK', 'SCROLL_LOCK'] as const;
+    const lockKeys = ['K_CAPS', 'K_NUMLOCK', 'K_SCROLL'] as const;
+    const lockModifiers = [ModifierKeyConstants.CAPITALFLAG, ModifierKeyConstants.NUMLOCKFLAG, ModifierKeyConstants.SCROLLFLAG] as const;


These, together with LL417-419, should be grouped together at the top of the module rather than declared at the top of the function

…erPress

github-project-automation bot added this to Keyman Dec 11, 2025

github-project-automation bot moved this to Todo in Keyman Dec 11, 2025

keymanapp-test-bot bot added the epic-web-core label Dec 11, 2025

keymanapp-test-bot bot changed the title ~~feat(web): implement doModifierPress~~ feat(web): implement doModifierPress 🎼 Dec 11, 2025

keymanapp-test-bot bot added this to the A19S18 milestone Dec 11, 2025

github-actions bot added web/ feat labels Dec 11, 2025

ermshiperete changed the base branch from refactor/web/cleanup to refactor/web/constants December 11, 2025 18:01

ermshiperete force-pushed the feat/web/15287_doModifierPress branch from 1bd3aa5 to 283f43f Compare December 11, 2025 18:05

ermshiperete requested a review from mcdurdin December 11, 2025 18:06

ermshiperete marked this pull request as ready for review December 11, 2025 18:06

ermshiperete force-pushed the refactor/web/constants branch from 5b3ea22 to 878b8ab Compare December 11, 2025 18:28

feat(web): implement doModifierPress

68de61a

Fixes: #15287 Test-bot: skip

ermshiperete force-pushed the feat/web/15287_doModifierPress branch from 283f43f to 68de61a Compare December 11, 2025 18:29

ermshiperete changed the title ~~feat(web): implement doModifierPress 🎼~~ feat(web): implement doModifierPress ✨ 🎼 Dec 15, 2025

keyman-server modified the milestones: A19S18, A19S19 Dec 21, 2025

mcdurdin requested changes Dec 22, 2025

View reviewed changes

Base automatically changed from refactor/web/constants to epic/web-core December 22, 2025 13:33

keyman-server modified the milestones: A19S19, A19S20 Jan 3, 2026

test(web): address code review comments

79cc8e7

ermshiperete requested a review from mcdurdin January 6, 2026 17:44

docs(web): document purpose of key codes > 50000

08a94ad

Build-bot: skip Test-bot: skip

github-actions bot added common/ common/web/ labels Jan 9, 2026

ermshiperete mentioned this pull request Jan 15, 2026

bug(web): wrong output with Caps Lock on hardware keyboard #15439

Open

keyman-server modified the milestones: A19S20, A19S21 Jan 16, 2026

chore(web): Merge remote-tracking branch 'origin/epic/web-core' into …

485ea55

…feat/web/15287_doModifierPress

mcdurdin approved these changes Jan 22, 2026

View reviewed changes

ermshiperete added 3 commits January 22, 2026 17:00

feat(web): address code review comments and fix build

2654257

chore(web): Merge branch 'epic/web-core' into feat/web/15287_doModifi…

7d57e83

…erPress

feat(web): fix build

7f110d1

ermshiperete enabled auto-merge January 22, 2026 16:17

ermshiperete merged commit c8c20b7 into epic/web-core Jan 22, 2026
6 checks passed

ermshiperete deleted the feat/web/15287_doModifierPress branch January 22, 2026 16:18

github-project-automation bot moved this from Todo to Done in Keyman Jan 22, 2026

github-actions bot mentioned this pull request Jan 22, 2026

feat(web): Implement doModifierPress 🎼 #15287

Closed

	export const enum
	TKeymanWebTouchStandardKey {
	K_LOPT = 50001,
	K_ROPT = 50002,
	K_NUMERALS = 50003,
	K_SYMBOLS = 50004,
	K_CURRENCIES = 50005,
	K_UPPER = 50006,
	K_LOWER = 50007,
	K_ALPHA = 50008,
	K_SHIFTED = 50009,
	K_ALTGR = 50010,
	K_TABBACK = 50011,
	K_TABFWD = 50012
	};

	As noted above, some `K_xxxx` codes emit characters, if no rule is defined.
	There are also some codes which have special functions:

	<table class="display">
	<thead>
	<tr>
	<th>Identifier</th>
	<th>Meaning</th>
	</tr>
	</thead>
	<tbody>
	<tr>
	<td markdown="1">`K_ENTER`</td>
	<td>Submit a form, or add a new line (multi-line); the key action may vary depending on the situation.</td>
	</tr>
	<tr>
	<td markdown="1">`K_BKSP`</td>
	<td>Delete back a single character. This key, if held down, will repeat. It is the only key code which triggers
	repeat behavior.</td>
	</tr>
	<tr>
	<td markdown="1">`K_LOPT`</td>
	<td>Open the language menu (aka Globe key).</td>
	</tr>
	<tr>
	<td markdown="1">`K_ROPT`</td>
	<td>Hide the on screen keyboard.</td>
	</tr>
	<tr>
	<td markdown="1">`K_TAB`, `K_TABBACK`, `K_TABFWD`</td>
	<td markdown="1">Move to next or previous element in a form. Note that these key functions are normally
	implemented outside the touch layout, so should not typically be used. `K_TAB` will go to previous
	element if used with the `shift` modifier.</td>
	</tr>
	</tbody>
	</table>

Uh oh!

Comments

Conversation

ermshiperete commented Dec 11, 2025

Uh oh!

keymanapp-test-bot bot commented Dec 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

User Test Results

Uh oh!

mcdurdin left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

keymanapp-test-bot bot commented Dec 11, 2025 •

edited

Loading