Repository navigation
feat: Unify hotkeys and sequences, and add app hotkeys - #175
Merged
Merged
Conversation
Hotkey APIs accept chords and sequences, the recorder records sequences with maxSteps, and app hotkeys are declared with defineAppHotkeys and customized through each adapter's provider.
🦋 Changeset detectedLatest commit: 74d73d4 The changes in this PR will be included in the next version bump. This PR includes changesets to release 18 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
WalkthroughWarning Review details and warnings were omitted to fit the comment limit. |
Contributor
🚀 Changeset Version Preview13 package(s) bumped directly, 5 bumped as dependents. 🟥 Major bumps
🟨 Minor bumps
🟩 Patch bumps
|
@tanstack/alpine-hotkeys
@tanstack/angular-hotkeys
@tanstack/angular-hotkeys-devtools
@tanstack/ember-hotkeys
@tanstack/hotkeys
@tanstack/hotkeys-devtools
@tanstack/lit-hotkeys
@tanstack/octane-hotkeys
@tanstack/preact-hotkeys
@tanstack/preact-hotkeys-devtools
@tanstack/react-hotkeys
@tanstack/react-hotkeys-devtools
@tanstack/solid-hotkeys
@tanstack/solid-hotkeys-devtools
@tanstack/svelte-hotkeys
@tanstack/svelte-hotkeys-devtools
@tanstack/vue-hotkeys
@tanstack/vue-hotkeys-devtools
commit: |
The hotkey and kitchen-sink examples registered with getHotkeyManager() and managed handles by hand. They now use HotkeyController with option getters for scoped targets, enabled state, requireReset, and timeouts. HotkeyController also accepts a getter for the hotkey, so a recorded binding re-registers after the host updates, as in Solid and Vue.
AlemTuzlak
approved these changes
Oct 14, 2026
Merged
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
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.
'Mod+S') or a sequence (['G', 'G']).HotkeyManager.register, every adapter's hotkey and hotkeys APIs,formatForDisplay,areHotkeysEqual,validateHotkey, and hints accept both. Types allowrequireResetonly for chords andtimeoutonly for sequences. A one-step array is treated as its chord.SequenceManagerand the separate sequence hooks, primitives, controllers, and recorders are removed.HotkeyRecorderrecords sequences withmaxStepsand replacescommitOnEnterwithcommitKeys.defineAppHotkeysandAppHotkeysStore. Pass declarations to a provider asappHotkeys, with optionalcustomHotkeysandonCustomHotkeysChange. Each adapter adds app hotkeys, app hotkey list, and custom hotkeys APIs for cheat sheets and rebinding, and setting a custom hotkey checks for conflicts. Lit, Alpine, and Ember have no provider and useprovideAppHotkeys.provideHotkeysContext, SveltesetHotkeysContext, and AngularprovideHotkeysnow take an options object. Devtools show one registration list with sequence progress, plus declared app hotkeys that aren't registered.HotkeyControlleraccepts a getter for the hotkey and its options, so recorded bindings, scoped targets, andenabledupdate after each host update. The Lit examples use controllers instead of callinggetHotkeyManager()directly; only the recorder examples, which register a changing list of shortcuts, still use the manager.useHotkey-sequences, etc.), example READMEs are removed, guides are rewritten with a new App Hotkeys guide, the TypeDoc reference is regenerated, anddocs/config.jsonis restructured.Notes
The changeset bumps every package a minor version and includes a breaking-changes table. Ember's
test:libneeds Chrome, so locally I ran its 14 tests in Playwright's Chromium; everything else passedpnpm test:ci.