How do I install the Tanstack Hotkeys skill?

Run npx skillmds@latest add dobroslavradosavljevic/tanstack-hotkeys in your terminal (requires Node.js), paste this page's agent-chat prompt into Claude, Cursor, or any MCP-connected agent, or download the SKILL.md file and copy it into your agent's skills directory.

Is Tanstack Hotkeys safe to use?

This skill has not completed SkillMD's automated safety review yet. SkillMD never runs a skill's scripts for you; review the SKILL.md before installing.

Which AI agents work with Tanstack Hotkeys?

This skill is tagged as working with Claude Code, Claude.ai, OpenAI Codex. SKILL.md is an open format, so most agents that read a skills directory can load it too.

Is Tanstack Hotkeys free to use?

Yes. Installing skills from SkillMD is free, and the skill stays under its author's original license.

Who published Tanstack Hotkeys?

dobroslavradosavljevic (@dobroslavradosavljevic) published this skill. Their other Agent Skills are listed on their SkillMD profile.

Tanstack Hotkeys by dobroslavradosavljevic

Name: Tanstack Hotkeys
Author: dobroslavradosavljevic

Tanstack Hotkeys

Build, review, debug, migrate, or plan TanStack Hotkeys keyboard shortcut systems with current docs. Use for @tanstack/react-hotkeys, @tanstack/hotkeys, useHotkey, useHotkeys, HotkeysProvider, useHotkeySequence, useHotkeySequences, useHotkeyRecorder, useHotkeySequenceRecorder, useHeldKeys, useHeldKeyCodes, useKeyHold, formatForDisplay, shortcut palettes, custom shortcut settings, key sequences, scoped hotkeys, input handling, preventDefault, stopPropagation, conflictBehavior, devtools, accessibility, SSR-safe React usage, and cross-platform Mod/Ctrl/Cmd shortcuts.

File contents

TanStack Hotkeys

Use this skill when work touches TanStack Hotkeys, especially React keyboard shortcuts, command palettes, shortcut settings UIs, scoped shortcuts, Vim-style sequences, or held-key state.

Workflow

Inspect the local shortcut stack before changing code:
- Package versions for @tanstack/react-hotkeys, @tanstack/hotkeys, devtools, React, framework adapter, and test utilities.
- Shortcut shape: one-off hotkeys, dynamic shortcut lists, element-scoped shortcuts, global defaults, sequences, user-recorded bindings, or shortcut palettes.
- Interaction constraints: focused inputs, modals, command palettes, native browser shortcuts, app modes, disabled state, and accessibility.
Refresh current docs and package evidence when behavior or versions matter. Start from source-map.md.
For installation, package names, HotkeysProvider, useHotkey, useHotkeys, defaults, options, and scoped targets, use setup-core.md.
For useHotkeySequence, useHotkeySequences, useHotkeyRecorder, useHotkeySequenceRecorder, held-key hooks, and dynamic user shortcuts, use sequences-recording-state.md.
For display formatting, shortcut palettes, devtools, SSR notes, accessibility, and testing, use display-production.md.

Implementation Judgment

Prefer Mod for cross-platform app shortcuts; it maps to Command on macOS and Control on Windows/Linux.
Treat the library as alpha. Verify current docs before relying on edge behavior, especially package names, adapters, recorder options, and sequence handling.
Use useHotkey for fixed shortcuts and useHotkeys for dynamic or variable-length lists. Do not call hooks inside loops to register menu data.
Scope hotkeys with target refs for panels, editors, and modals. Ensure the target can receive focus, usually with tabIndex.
Leave preventDefault and stopPropagation intentional. They default to true, which is right for app shortcuts like Mod+S but wrong when native browser behavior should remain.
Respect normal typing. Understand the smart ignoreInputs default before forcing single-key shortcuts to fire in text inputs.
Use enabled for mode/state gating. Disabled hotkeys remain registered and visible in devtools; execution is suppressed.
Add meta names and descriptions for shortcuts that appear in help screens, command palettes, or devtools.
Use recorder hooks only for settings UIs where users customize shortcuts. Persist normalized Hotkey or HotkeySequence values, not display labels.

Verification

Prefer the repo's existing checks. For meaningful TanStack Hotkeys changes, include the relevant subset:

Typecheck for hotkey strings, Hotkey/HotkeySequence values, target refs, and adapter imports.
Unit or component tests for callback firing, enabled, ignoreInputs, preventDefault, stopPropagation, target focus, and cleanup on unmount.
Browser smoke for cross-platform display labels, focused input behavior, modal scoping, command palette shortcuts, and sequence timeouts.
Tests with fake timers for sequence timeout, recorder idle commit, and debounced UI around shortcut capture.
Devtools inspection for duplicate registrations, disabled registrations, held keys, target scoping, and conflict behavior.

---name: tanstack-hotkeysdescription: Build, review, debug, migrate, or plan TanStack Hotkeys keyboard shortcut systems with current docs. Use for @tanstack/react-hotkeys, @tanstack/hotkeys, useHotkey, useHotkeys, HotkeysProvider, useHotkeySequence, useHotkeySequences, useHotkeyRecorder, useHotkeySequenceRecorder, useHeldKeys, useHeldKeyCodes, useKeyHold, formatForDisplay, shortcut palettes, custom shortcut settings, key sequences, scoped hotkeys, input handling, preventDefault, stopPropagation, conflictBehavior, devtools, accessibility, SSR-safe React usage, and cross-platform Mod/Ctrl/Cmd shortcuts.---# TanStack HotkeysUse this skill when work touches TanStack Hotkeys, especially React keyboard shortcuts, command palettes, shortcut settings UIs, scoped shortcuts, Vim-style sequences, or held-key state.## Workflow1. Inspect the local shortcut stack before changing code: - Package versions for `@tanstack/react-hotkeys`, `@tanstack/hotkeys`, devtools, React, framework adapter, and test utilities. - Shortcut shape: one-off hotkeys, dynamic shortcut lists, element-scoped shortcuts, global defaults, sequences, user-recorded bindings, or shortcut palettes. - Interaction constraints: focused inputs, modals, command palettes, native browser shortcuts, app modes, disabled state, and accessibility.2. Refresh current docs and package evidence when behavior or versions matter. Start from [source-map.md](references/source-map.md).3. For installation, package names, `HotkeysProvider`, `useHotkey`, `useHotkeys`, defaults, options, and scoped targets, use [setup-core.md](references/setup-core.md).4. For `useHotkeySequence`, `useHotkeySequences`, `useHotkeyRecorder`, `useHotkeySequenceRecorder`, held-key hooks, and dynamic user shortcuts, use [sequences-recording-state.md](references/sequences-recording-state.md).5. For display formatting, shortcut palettes, devtools, SSR notes, accessibility, and testing, use [display-production.md](references/display-production.md).## Implementation Judgment- Prefer `Mod` for cross-platform app shortcuts; it maps to Command on macOS and Control on Windows/Linux.- Treat the library as alpha. Verify current docs before relying on edge behavior, especially package names, adapters, recorder options, and sequence handling.- Use `useHotkey` for fixed shortcuts and `useHotkeys` for dynamic or variable-length lists. Do not call hooks inside loops to register menu data.- Scope hotkeys with `target` refs for panels, editors, and modals. Ensure the target can receive focus, usually with `tabIndex`.- Leave `preventDefault` and `stopPropagation` intentional. They default to `true`, which is right for app shortcuts like `Mod+S` but wrong when native browser behavior should remain.- Respect normal typing. Understand the smart `ignoreInputs` default before forcing single-key shortcuts to fire in text inputs.- Use `enabled` for mode/state gating. Disabled hotkeys remain registered and visible in devtools; execution is suppressed.- Add `meta` names and descriptions for shortcuts that appear in help screens, command palettes, or devtools.- Use recorder hooks only for settings UIs where users customize shortcuts. Persist normalized `Hotkey` or `HotkeySequence` values, not display labels.## VerificationPrefer the repo's existing checks. For meaningful TanStack Hotkeys changes, include the relevant subset:- Typecheck for hotkey strings, `Hotkey`/`HotkeySequence` values, target refs, and adapter imports.- Unit or component tests for callback firing, `enabled`, `ignoreInputs`, `preventDefault`, `stopPropagation`, target focus, and cleanup on unmount.- Browser smoke for cross-platform display labels, focused input behavior, modal scoping, command palette shortcuts, and sequence timeouts.- Tests with fake timers for sequence timeout, recorder idle commit, and debounced UI around shortcut capture.- Devtools inspection for duplicate registrations, disabled registrations, held keys, target scoping, and conflict behavior.

Frequently asked questions