MCPcopy Index your code
hub / github.com/TanStack/hotkeys

github.com/TanStack/hotkeys @main

Chat with this repo
repository ↗ · DeepWiki ↗ · + Follow
786 symbols 2,396 edges 366 files 108 documented · 14% 2 cross-repo links updated 47d ago@tanstack/solid-hotkeys-devtools@0.7.0 · 2026-04-25★ 64218 open issues
What it actually does AI analysis from the code graph — generated when you open this
loading…
README

TanStack Hotkeys

<a href="https://www.npmjs.com/package/@tanstack/hotkeys" target="\_parent">
  <img alt="" src="https://img.shields.io/npm/dm/@tanstack/hotkeys.svg" alt="npm downloads" />
</a>
<a href="https://github.com/TanStack/hotkeys" target="\_parent">
  <img alt="" src="https://img.shields.io/github/stars/TanStack/hotkeys.svg?style=social&label=Star" alt="GitHub stars" />
</a>
<a href="https://bundlephobia.com/result?p=@tanstack/react-hotkeys@latest" target="\_parent">
  <img alt="" src="https://badgen.net/bundlephobia/minzip/@tanstack/react-hotkeys@latest" alt="Bundle size" />
</a>







<a href="#badge">
  <img alt="semantic-release" src="https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg">
</a>
<a href="#badge">
  <img src="https://img.shields.io/github/v/release/tanstack/hotkeys" alt="Release"/>
</a>
<a href="https://twitter.com/tan_stack">
  <img src="https://img.shields.io/twitter/follow/tan_stack.svg?style=social" alt="Follow @TanStack"/>
</a>

Become a Sponsor!

TanStack Hotkeys

[!NOTE] TanStack Hotkeys is alpha. We are actively developing the library and are open to feedback and contributions.

Type-safe keyboard shortcuts for the web. Template-string bindings, parsed objects, a cross-platform Mod key, a singleton Hotkey Manager, and utilities for cheatsheet UIs—built to stay SSR-friendly.

  • Type-safe bindings — template strings (Mod+Shift+S, Escape) or parsed objects for full control
  • Flexible options — keydown/keyup, preventDefault, stopPropagation, conditional enabled, requireReset
  • Cross-platform Mod — maps to Cmd on macOS and Ctrl on Windows/Linux
  • Batteries included — validation + matching, sequences (Vim-style), key-state tracking, recorder UI helpers, framework adapters, and devtools

Read the docs →

[!NOTE] You may know TanStack Hotkeys by our adapter names, too!

Get Involved

Partners

CodeRabbit Cloudflare

Keys & you?

We're looking for TanStack Hotkeys Partners to join our mission! Partner with us to push the boundaries of TanStack Hotkeys and build amazing things together.

LET'S CHAT

Explore the TanStack Ecosystem

… and more at TanStack.com »

Extension points exported contracts — how you extend this code

SequenceRegistration (Interface)
* Internal representation of a sequence registration.
packages/hotkeys/src/sequence-manager.ts
SvelteHotkeySequenceRecorder (Interface)
(no doc) [1 implementers]
packages/svelte-hotkeys/src/createHotkeySequenceRecorder.svelte.ts
CreateHotkeySequenceOptions (Interface)
(no doc)
packages/solid-hotkeys/src/createHotkeySequence.ts
HotkeyRegistrationsResult (Interface)
(no doc)
packages/react-hotkeys/src/useHotkeyRegistrations.ts
HotkeysProviderOptions (Interface)
(no doc)
packages/angular-hotkeys/src/hotkeys-provider.ts
HotkeysDevtoolsPreactInit (Interface)
(no doc)
packages/preact-hotkeys-devtools/src/PreactHotkeysDevtools.tsx
HotkeysProviderOptions (Interface)
(no doc)
packages/vue-hotkeys/src/HotkeysProviderContext.ts
HotkeyRegistrationsResult (Interface)
(no doc)
packages/preact-hotkeys/src/useHotkeyRegistrations.ts

Core symbols most depended-on inside this repo

formatForDisplay
called by 304
packages/hotkeys/src/format.ts
getInstance
called by 203
packages/hotkeys/src/hotkey-manager.ts
register
called by 168
packages/hotkeys/src/hotkey-manager.ts
t
called by 107
packages/hotkeys-devtools/src/styles/use-styles.ts
matchesKeyboardEvent
called by 92
packages/hotkeys/src/match.ts
getRegistrationCount
called by 82
packages/hotkeys/src/hotkey-manager.ts
createHotkey
called by 54
packages/solid-hotkeys/src/createHotkey.ts
useHotkey
called by 54
packages/react-hotkeys/src/useHotkey.ts

Shape

Function 374
Method 229
Interface 113
Class 70

Languages

TypeScript100%

Modules by API surface

packages/hotkeys/src/sequence-manager.ts33 symbols
packages/hotkeys/src/hotkey-manager.ts29 symbols
packages/hotkeys-devtools/src/components/HotkeyList.tsx22 symbols
packages/hotkeys-devtools/src/components/DetailsPanel.tsx22 symbols
packages/hotkeys/src/hotkey-sequence-recorder.ts19 symbols
packages/hotkeys/src/key-state-tracker.ts16 symbols
examples/lit/hotkey-sequence-recorder/src/app.ts16 symbols
examples/lit/hotkey-sequence/src/app.ts15 symbols
examples/lit/hotkey-recorder/src/app.ts15 symbols
packages/svelte-hotkeys/src/createHotkeySequenceRecorder.svelte.ts14 symbols
examples/angular/injectHotkeySequenceRecorder/src/app/app.component.ts14 symbols
packages/lit-hotkeys/src/controllers/hotkey-sequence-recorder.ts13 symbols

Used by 2 indexed graphs manifest dependencies, hub-wide

For agents

$ claude mcp add hotkeys \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact