[Keyboard Manager] Toggle module hotkey/shortcut by weikequ · Pull Request #42472 · microsoft/PowerToys

weikequ · 2025-10-17T04:57:11Z

Summary of the Pull Request

Adds a keyboard shortcut to be able to toggle the Keyboard Manager module on and off.

PR Checklist

Detailed Description of the Pull Request / Additional comments

Modeled the changes and addition of a global shortcut using the Color Picker module.

Notes:

This uses KeyboardManagerSettings and the associated .json settings file. I don't think there's anything else in this module that uses this.
The default key binding for this is winkey + shift + k
I've had to update the KeyboardManagerViewModel to extend PageViewModelBase as opposed to Observable to get it to work. But I will say that there were some things in here that I didn't fully dig into, so let me know if there's any potential things I'm missing.
I'm not too sure how to update the Settings UI after a hotkey is pressed (pressing the hotkey currently will not show the module being toggled off) - can't find a good way to refresh the settings ui after enabling/disabling the module. Any pointers here would be appreciated!

Validation Steps Performed

Manually validated the following items:
- Using the default shortcut (winkey + shift + k)
- Changing the shortcut
- Ensuring the change is persistent

Media

Screen.Recording.2025-10-21.173753.mp4

weikequ · 2025-10-17T04:59:29Z

@microsoft-github-policy-service agree

…/PowerToys into keyboard-manager-toggle-shortcut

mike-mgt · 2025-11-13T17:12:24Z

Thanks for posting this as a PR. I was going to install your release, but I'll wait for this to be merged to prod.

niels9001 · 2025-12-10T13:24:08Z

@weikequ we want to get this in for the next release. Would you mind resolving the remaining conflicts so that we can get this reviewed and merged in :)?

weikequ · 2025-12-11T00:15:56Z

@weikequ we want to get this in for the next release. Would you mind resolving the remaining conflicts so that we can get this reviewed and merged in :)?

Awesome to hear. Just pushed a fix to resolve the merge conflicts. Let me know if there's anything else you need on my end. Thanks!

lei9444 · 2026-01-05T08:24:19Z

/azp run

azure-pipelines · 2026-01-05T08:24:29Z

Azure Pipelines successfully started running 1 pipeline(s).

Copilot

Pull request overview

This PR adds a keyboard shortcut feature to toggle the Keyboard Manager module on and off, addressing issue #4879. The implementation follows the pattern used in the Color Picker module, with a default hotkey of Win+Shift+K.

Key changes:

Adds toggle hotkey infrastructure to Keyboard Manager with configurable shortcut
Extends KeyboardManagerViewModel to inherit from PageViewModelBase for hotkey support
Implements hotkey parsing and toggle functionality in the C++ module DLL

Reviewed changes

Copilot reviewed 8 out of 8 changed files in this pull request and generated 3 comments.

Show a summary per file

File	Description
src/settings-ui/Settings.UI/ViewModels/KeyboardManagerViewModel.cs	Refactors ViewModel to extend PageViewModelBase and implements GetAllHotkeySettings() method to expose the toggle shortcut configuration
src/settings-ui/Settings.UI/Strings/en-us/Resources.resw	Adds localized strings for the toggle shortcut UI header and description
src/settings-ui/Settings.UI/SettingsXAML/Views/KeyboardManagerPage.xaml	Adds ShortcutControl UI element for configuring the toggle shortcut
src/settings-ui/Settings.UI/SerializationContext/SourceGenerationContextContext.cs	Registers KeyboardManagerSettings for JSON serialization context
src/settings-ui/Settings.UI.Library/KeyboardManagerSettings.cs	Implements GetAllHotkeyAccessors() method to provide access to the toggle shortcut setting
src/settings-ui/Settings.UI.Library/KeyboardManagerProperties.cs	Adds ToggleShortcut property with default value (Win+Shift+K)
src/modules/keyboardmanager/dll/dllmain.cpp	Implements hotkey parsing, storage, and toggle handler that enables/disables the module with toast notifications
src/modules/keyboardmanager/dll/KeyboardManager.vcxproj	Adds project reference to the notifications library for toast support

Copilot · 2026-01-06T05:59:33Z

+            notifications::show_toast(L"Keyboard Manager Disabled", L"");
+        }
+        else
+        {
+            enable();
+            notifications::show_toast(L"Keyboard Manager Enabled", L"");


The notification strings "Keyboard Manager Disabled" and "Keyboard Manager Enabled" are hardcoded and not localized. These should use GET_RESOURCE_STRING with appropriate resource IDs defined in the Resources.resx file to support internationalization, similar to how app_name uses GET_RESOURCE_STRING(IDS_KEYBOARDMANAGER) on line 51.

Suggested change

notifications::show_toast(L"Keyboard Manager Disabled", L"");

}

else

{

enable();

notifications::show_toast(L"Keyboard Manager Enabled", L"");

notifications::show_toast(GET_RESOURCE_STRING(IDS_KEYBOARDMANAGER_DISABLED), L"");

}

else

{

enable();

notifications::show_toast(GET_RESOURCE_STRING(IDS_KEYBOARDMANAGER_ENABLED), L"");

lei9444 · 2026-01-06T06:00:21Z

/azp run

azure-pipelines · 2026-01-06T06:00:31Z

Azure Pipelines successfully started running 1 pipeline(s).

yeelam-gordon · 2026-01-06T07:51:26Z

@weikequ and @niels9001 , should we consider another existing pattern in PowerToys?
Like below screenshot.

Disable the module in specific scenarios (e.g., GameMode).
Disable the module for specific apps.
This pattern is more feasible because it can be configured to disable the module in specific situations, rather than requiring people to remember to use a hotkey.

lei9444 · 2026-01-06T07:52:24Z

Hi @weikequ @niels9001,
directly toggling the whole module feels a bit odd.
Should we follow a similar approach to Mouse Utilities — use a shortcut to enable/disable the functionality, e.g. stop listening to keyboard events, instead of turning the entire module on and off?

mike-mgt · 2026-01-06T08:12:28Z

Hi @weikequ @niels9001, directly toggling the whole module feels a bit odd. Should we follow a similar approach to Mouse Utilities — use a shortcut to enable/disable the functionality, e.g. stop listening to keyboard events, instead of turning the entire module on and off?

Nope. The module itself is problematic when it is on in certain scenarios. If you're suggesting an additional setting, great, but this is a much-needed feature.

mike-mgt · 2026-01-06T08:14:28Z

@weikequ and @niels9001 , should we consider another existing pattern in PowerToys? Like below screenshot.

Disable the module in specific scenarios (e.g., GameMode).

Disable the module for specific apps.
This pattern is more feasible because it can be configured to disable the module in specific situations, rather than requiring people to remember to use a hotkey.

I do like this as an option, but I think it should also be added as an extra setting on top of the proposed one here by @weikequ.

lei9444 · 2026-01-06T10:10:33Z

Hi @weikequ @niels9001, directly toggling the whole module feels a bit odd. Should we follow a similar approach to Mouse Utilities — use a shortcut to enable/disable the functionality, e.g. stop listening to keyboard events, instead of turning the entire module on and off?

Nope. The module itself is problematic when it is on in certain scenarios. If you're suggesting an additional setting, great, but this is a much-needed feature.

Thanks @mike-mgt for the comments.
My suggestion is like this: the shortcut will activate (enable) and deactivate (disable) the module, but it will not change the module’s settings state shown in Settings.

So it behaves like this:
When the module is enabled in Settings, we can toggle the module active/inactive via the shortcut:

When the module is disabled in Settings, the shortcut does nothing:

This way, our implementation stays consistent with others.
Does this approach satisfy your requirements?

niels9001 · 2026-01-06T10:23:05Z

+    // Process the hotkey event
+    virtual bool on_hotkey(size_t /*hotkeyId*/) override
+    {
+        if (m_enabled)


We currently only use notifications to communicate updates and other 'critical' things as we know users don't like to get too many notifications.

Since enabling/disabling KMB is a deliberate action by the user, notifications seem excessive.

When I was testing it, it was really helpful to know when the action was successful, hence the notification. Having the user press a hotkey and receive no feedback is unintuitive imo , as it makes them question if anything happened. I still prefer somehow letting the user know when it has succeeded, do you have any other thoughts on how we might be able to do it without using the notification system?

Thanks for sprinkling some good US @weikequ. Being notified of a successful activation is essential. I use SoundSwitch and I love seeing the notification that clearly states whether the input has switched or there's been an error.

niels9001

Great work! See comment about notifications.

And to @lei9444 's comment; we should follow the activation behavior that other utilities are using so we are in line. This would also set us up for success on the longer term as we are planning a UI revamp of the KBM editor :)!

weikequ · 2026-01-06T18:06:50Z

1. Disable the module in specific scenarios (e.g., GameMode).
2. Disable the module for specific apps.

I think it would be hard to capture all scenarios/apps where this would help the user, and using a specific keyboard press helps solidify user intent on performing this action. Though for my own purposes, this does work as well (maybe a blacklist to select from a list of processes?).

The other option is to have no shortcut by default, that way, it is opt-in only for those who need it.

…le-shortcut

vanzue · 2026-02-11T10:55:15Z

/azp run

azure-pipelines · 2026-02-11T10:55:26Z

Azure Pipelines successfully started running 1 pipeline(s).

Copilot

Pull request overview

Copilot reviewed 9 out of 10 changed files in this pull request and generated 4 comments.

Copilot · 2026-02-11T11:01:56Z

+    <value>Toggle shortcut</value>
+  </data>
+  <data name="KeyboardManager_Toggle_Shortcut.Description" xml:space="preserve">
+    <value>Use a shortcut to toggle this module on or off (note that the Settings UI will not update)</value>


The description text mentions that "the Settings UI will not update" when the hotkey is pressed. This is a user-facing limitation that should ideally be addressed. Consider implementing a mechanism to notify the Settings UI of the state change, similar to how GeneralSettings.Enabled is updated in other toggle scenarios. This could involve sending an IPC message back to the Settings UI or implementing a polling/refresh mechanism.

Suggested change

<value>Use a shortcut to toggle this module on or off (note that the Settings UI will not update)</value>

<value>Use a shortcut to toggle this module on or off from anywhere</value>

Copilot · 2026-02-11T11:01:56Z

+    // Process the hotkey event
+    virtual bool on_hotkey(size_t /*hotkeyId*/) override
+    {
+        if (!m_enabled)
+        {
+            return false;
+        }
+
+        constexpr ULONGLONG hotkeyToggleDebounceMs = 500;
+        const auto now = GetTickCount64();
+        if (now - m_lastHotkeyToggleTime < hotkeyToggleDebounceMs)
+        {
+            return true;
+        }
+        m_lastHotkeyToggleTime = now;
+
+        refresh_process_state();
+        if (m_active)
+        {
+            stop_engine();
+        }
+        else
+        {
+            start_engine();
+        }
+
+        return true;
+    }


When toggling the engine via hotkey, no telemetry is sent, unlike the enable/disable methods which call Trace::EnableKeyboardManager. Consider whether telemetry should be tracked for hotkey toggles to understand user behavior, or document why it's intentionally omitted (e.g., to avoid spam from frequent toggling).

Copilot · 2026-02-11T11:01:56Z

+        public HotkeySettings ToggleShortcut
+        {
+            get => Settings.Properties.ToggleShortcut;
+            set
+            {
+                if (Settings.Properties.ToggleShortcut != value)
+                {
+                    Settings.Properties.ToggleShortcut = value ?? Settings.Properties.DefaultToggleShortcut;
+                    OnPropertyChanged(nameof(ToggleShortcut));
+                    NotifySettingsChanged();
+                }
+            }
+        }


Consider adding unit tests for the new toggle shortcut functionality, similar to the tests in ViewModelTests/ColorPicker.cs that verify the ActivationShortcut property. Tests should verify that the ToggleShortcut property is correctly initialized, persisted, and updated. This aligns with the PR checklist item for tests that is currently unchecked.

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

vanzue · 2026-02-11T16:11:06Z

/azp run

azure-pipelines · 2026-02-11T16:11:17Z

Azure Pipelines successfully started running 1 pipeline(s).

vanzue · 2026-02-11T16:17:16Z

Addressed the comments:

Hotkey toggle will not enable disable the entire module, use a slightly light weighted approach to start the engine/kill the engine process
Removed the notification

jefflord · 2026-03-19T11:04:23Z

Wow, so long over due and it's brilliant.

Couple if nits:

Tab Order: The tab order is inconsistent. When a shortcut has focus, pressing Tab again focuses on nothing (likely hidden elements) rather than moving to the next visible control.
Menu Options: The "..." (meatballs) menu should include an "Edit" option.
Broken Icon: The "folder-with-arrow" icon currently has no associated action.
Chord Regressions: Double-key chords (e.g., CTRL+6, 6) no longer work. The UI prevents the second part of the chord from being entered (see Image 1)
Chord Timing: The timeout for entering the second character of a chord is far too short. Unlike standard chord entries that often have no strict "allotted time," this screen resets too quickly. If a timeout is necessary, please add a hint when "Allow chords" is checked: "Enter the second part of the chord within 1 second, or the input will reset."
UI Guidance: There should be a label below the shortcut display saying: "Click or focus here to enter a shortcut."
Keyboard Accessibility: "Esc" should not be a valid shortcut key. Instead, pressing "Esc" should blur the input and disable shortcut entry. Currently, it's impossible to navigate or configure the shortcut settings using only the keyboard.
Dropdown Redundancy: Why is "Trigger" a dropdown menu if it only contains one option?

Image 1: Double same number chords

Again I will say, OMG this is great. I have personally waited for this for a long time.

weikequ · 2026-04-02T01:04:28Z

Not too sure what happened between my changes and what was merged, but I'm using the .98 release and the keyboard manager gets randomly disabled (through the shortcut, the UI is still showing it's on) when I run certain apps. Not too sure what the cause is though. Will update if I find more information.

mike-mgt · 2026-04-02T01:15:15Z

Just curious @weikequ, did your original contribution support UI syncing? I noticed the comment in the changelog saying that the UI would not reflect the toggling via keyboard shortcut. I also noticed some extra commits and conversations regarding changing the behaviour of the trigger to be more in line with other toggles. Not sure what happened there, but I'm noticing issues as well. I am staying in .98.0 to avoid the feature removal.

Not too sure what happened between my changes and what was merged, but I'm using the .98 release and the keyboard manager gets randomly disabled (through the shortcut, the UI is still showing it's on) when I run certain apps. Not too sure what the cause is though. Will update if I find more information.

weikequ · 2026-04-02T01:22:32Z

Just curious @weikequ, did your original contribution support UI syncing? I noticed the comment in the changelog saying that the UI would not reflect the toggling via keyboard shortcut. I also noticed some extra commits and conversations regarding changing the behaviour of the trigger to be more in line with other toggles. Not sure what happened there, but I'm noticing issues as well. I am staying in .98.0 to avoid the feature removal.

I asked about the UI issues when I first created the PR but it seemed like no-one had any ideas, so no, it was never implemented. The extra commits I have no idea, sorry. If you can add the issues you're having here and steps to reproduce it, I can try to take a look at it along with my issues

mike-mgt · 2026-05-06T21:18:03Z

Hi @weikequ just wondering if you know anything about the feature. It seems like it's been removed without any reporting of bringing it back. I saw this issue and related PR #46821 #46530 but no sign of it coming back. I do see more changes made to the overall module. I'd love to sideload your changes, if you were to create a new PR that includes the April 29 improvements (there's some good stuff there https://github.com/microsoft/PowerToys/releases/tag/v0.99.1). Cheers!

Weike Qu and others added 2 commits October 16, 2025 18:51

feat: add keyboard manager toggle shortcut

c45b279

Merge branch 'microsoft:main' into keyboard-manager-toggle-shortcut

871d568

weikequ and others added 4 commits October 17, 2025 08:42

Merge branch 'main' into keyboard-manager-toggle-shortcut

13bda0e

chore: update resource string name, add notifications to keypress

22a2733

Merge branch 'keyboard-manager-toggle-shortcut' of github.com:weikequ…

1cc68c5

…/PowerToys into keyboard-manager-toggle-shortcut

Merge branch 'microsoft:main' into keyboard-manager-toggle-shortcut

36b52c2

weikequ marked this pull request as ready for review October 23, 2025 21:13

niels9001 added the In for .97 label Dec 10, 2025

niels9001 requested a review from zateutsch December 10, 2025 13:23

Merge branch 'main' into keyboard-manager-toggle-shortcut

ba9a1aa

lei9444 requested a review from Copilot January 6, 2026 05:49

Copilot started reviewing on behalf of lei9444 January 6, 2026 05:50 View session

fix style

a4d1ca7

Copilot AI reviewed Jan 6, 2026

View reviewed changes

niels9001 reviewed Jan 6, 2026

View reviewed changes

niels9001 requested changes Jan 6, 2026

View reviewed changes

vanzue added 2 commits February 11, 2026 18:43

Toggle mode instead of module load unload mode for toggle

7171e5e

Merge remote-tracking branch 'origin/main' into keyboard-manager-togg…

b0cc315

…le-shortcut

vanzue requested a review from Copilot February 11, 2026 10:51

Copilot started reviewing on behalf of vanzue February 11, 2026 10:52 View session

restore status to main

4357aad

Copilot AI reviewed Feb 11, 2026

View reviewed changes

vanzue and others added 2 commits February 11, 2026 23:15

Restore KeyboardEventHandlers toast logic from origin/main

7d5d985

Apply suggestion from @Copilot

cd97de3

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

vanzue requested a review from niels9001 February 11, 2026 16:17

niels9001 approved these changes Feb 12, 2026

View reviewed changes

niels9001 merged commit f88a490 into microsoft:main Feb 12, 2026
11 checks passed

zateutsch added this to the PowerToys 0.98 milestone Mar 4, 2026

zateutsch added the Product-Keyboard Shortcut Manager Issues regarding Keyboard Shortcut Manager label Mar 5, 2026

	<value>Use a shortcut to toggle this module on or off (note that the Settings UI will not update)</value>
	<value>Use a shortcut to toggle this module on or off from anywhere</value>

Uh oh!

Conversation

weikequ commented Oct 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary of the Pull Request

PR Checklist

Detailed Description of the Pull Request / Additional comments

Validation Steps Performed

Media

Uh oh!

weikequ commented Oct 17, 2025

Uh oh!

mike-mgt commented Nov 13, 2025

Uh oh!

niels9001 commented Dec 10, 2025

Uh oh!

weikequ commented Dec 11, 2025

Uh oh!

lei9444 commented Jan 5, 2026

Uh oh!

azure-pipelines Bot commented Jan 5, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Jan 6, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

lei9444 commented Jan 6, 2026

Uh oh!

azure-pipelines Bot commented Jan 6, 2026

Uh oh!

yeelam-gordon commented Jan 6, 2026

Uh oh!

lei9444 commented Jan 6, 2026

Uh oh!

mike-mgt commented Jan 6, 2026

Uh oh!

mike-mgt commented Jan 6, 2026

Uh oh!

lei9444 commented Jan 6, 2026

Uh oh!

niels9001 Jan 6, 2026

Choose a reason for hiding this comment

Uh oh!

weikequ Jan 6, 2026

Choose a reason for hiding this comment

Uh oh!

mike-mgt Jan 23, 2026

Choose a reason for hiding this comment

Uh oh!

niels9001 left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

weikequ commented Jan 6, 2026

Uh oh!

vanzue commented Feb 11, 2026

Uh oh!

azure-pipelines Bot commented Feb 11, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Copilot AI Feb 11, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 11, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 11, 2026

Choose a reason for hiding this comment

Uh oh!

vanzue commented Feb 11, 2026

weikequ commented Oct 17, 2025 •

edited

Loading

niels9001 left a comment •

edited

Loading