TanStack
Hotkeys
v0
v0
Alpha
Try TanStack CLI
Search...
K
Auto
Log In
Start
RC
Start
RC
Router
Router
Query
Query
Table
Table
DB
beta
DB
beta
AI
alpha
AI
alpha
Form
new
Form
new
Virtual
Virtual
Pacer
beta
Pacer
beta
Hotkeys
alpha
Hotkeys
alpha
Store
alpha
Store
alpha
Devtools
alpha
Devtools
alpha
CLI
alpha
CLI
alpha
More Libraries
More Libraries
Builder
Alpha
Builder
Alpha
Feed
Beta
Feed
Beta
Maintainers
Maintainers
Partners
Partners
Showcase
Showcase
Blog
Blog
Learn
NEW
Learn
NEW
Support
Support
Stats
Stats
Discord
Discord
Merch
Merch
GitHub
GitHub
Ethos
Ethos
Tenets
Tenets
Brand Guide
Brand Guide
Docs
Partners
React
Latest
Search...
K
Menu
Home
Contributors
NPM Stats
GitHub
Discord
Getting Started
Overview
Installation
Devtools
Quick Start
Guides
Hotkeys
Sequences
Hotkey Recording
Key State Tracking
Formatting & Display
API Reference
Core API
React Hooks
Hotkeys API Reference
HotkeyManager
getHotkeyManager
HotkeyOptions
HotkeyRegistration
HotkeyRegistrationHandle
HotkeyCallback
HotkeyCallbackContext
ConflictBehavior
useHotkey
UseHotkeyOptions
Hotkey Sequence API Reference
SequenceManager
getSequenceManager
SequenceOptions
createSequenceMatcher
HotkeySequence
useHotkeySequence
UseHotkeySequenceOptions
Key Hold API Reference
KeyStateTracker
getKeyStateTracker
KeyStateTrackerState
HeldKey
useKeyHold
Held Keys API Reference
KeyStateTracker
getKeyStateTracker
KeyStateTrackerState
HeldKey
useHeldKeys
useHeldKeyCodes
Hotkey Recorder API Reference
HotkeyRecorder
HotkeyRecorderOptions
HotkeyRecorderState
useHotkeyRecorder
ReactHotkeyRecorder
Format for Display API Reference
formatForDisplay
formatHotkey
formatKeyForDebuggingDisplay
formatWithLabels
convertToModFormat
FormatDisplayOptions
FormatKeyDebuggingOptions
KEY_DISPLAY_SYMBOLS
MAC_MODIFIER_SYMBOLS
STANDARD_MODIFIER_LABELS
MODIFIER_ALIASES
MODIFIER_ORDER
MODIFIER_KEYS
Examples
useHotkey
useHotkeySequence
useHotkeyRecorder
useHeldKeys
useKeyHold
latest
React
Latest
Menu
Home
Contributors
NPM Stats
GitHub
Discord
Getting Started
Overview
Installation
Devtools
Quick Start
Guides
Hotkeys
Sequences
Hotkey Recording
Key State Tracking
Formatting & Display
API Reference
Core API
React Hooks
Hotkeys API Reference
HotkeyManager
getHotkeyManager
HotkeyOptions
HotkeyRegistration
HotkeyRegistrationHandle
HotkeyCallback
HotkeyCallbackContext
ConflictBehavior
useHotkey
UseHotkeyOptions
Hotkey Sequence API Reference
SequenceManager
getSequenceManager
SequenceOptions
createSequenceMatcher
HotkeySequence
useHotkeySequence
UseHotkeySequenceOptions
Key Hold API Reference
KeyStateTracker
getKeyStateTracker
KeyStateTrackerState
HeldKey
useKeyHold
Held Keys API Reference
KeyStateTracker
getKeyStateTracker
KeyStateTrackerState
HeldKey
useHeldKeys
useHeldKeyCodes
Hotkey Recorder API Reference
HotkeyRecorder
HotkeyRecorderOptions
HotkeyRecorderState
useHotkeyRecorder
ReactHotkeyRecorder
Format for Display API Reference
formatForDisplay
formatHotkey
formatKeyForDebuggingDisplay
formatWithLabels
convertToModFormat
FormatDisplayOptions
FormatKeyDebuggingOptions
KEY_DISPLAY_SYMBOLS
MAC_MODIFIER_SYMBOLS
STANDARD_MODIFIER_LABELS
MODIFIER_ALIASES
MODIFIER_ORDER
MODIFIER_KEYS
Examples
useHotkey
useHotkeySequence
useHotkeyRecorder
useHeldKeys
useKeyHold
AI/LLM: This documentation page is available in plain markdown format at/hotkeys/latest/docs/reference/index.md
Learn about TanStack Ads
Hide Ads
API Reference
On this page
@tanstack/hotkeys
Copy page
@tanstack/hotkeys
Classes
HotkeyManager
HotkeyRecorder
KeyStateTracker
SequenceManager
Interfaces
CreateHotkeyHandlerOptions
FormatDisplayOptions
FormatKeyDebuggingOptions
HotkeyCallbackContext
HotkeyOptions
HotkeyRecorderOptions
HotkeyRecorderState
HotkeyRegistration
HotkeyRegistrationHandle
KeyStateTrackerState
ParsedHotkey
RawHotkey
SequenceOptions
ValidationResult
Type Aliases
CanonicalModifier
ConflictBehavior
EditingKey
FunctionKey
HeldKey
Hotkey
HotkeyCallback
HotkeySequence
Key
LetterKey
Modifier
NavigationKey
NumberKey
PunctuationKey
RegisterableHotkey
Variables
ALL_KEYS
EDITING_KEYS
FUNCTION_KEYS
KEY_DISPLAY_SYMBOLS
LETTER_KEYS
MAC_MODIFIER_SYMBOLS
MODIFIER_ALIASES
MODIFIER_KEYS
MODIFIER_ORDER
NAVIGATION_KEYS
NUMBER_KEYS
PUNCTUATION_KEYS
STANDARD_MODIFIER_LABELS
Functions
assertValidHotkey
checkHotkey
convertToModFormat
createHotkeyHandler
createMultiHotkeyHandler
createSequenceMatcher
detectPlatform
formatForDisplay
formatHotkey
formatKeyForDebuggingDisplay
formatWithLabels
getHotkeyManager
getKeyStateTracker
getSequenceManager
hasNonModifierKey
isModifier
isModifierKey
keyboardEventToHotkey
matchesKeyboardEvent
normalizeHotkey
normalizeKeyName
parseHotkey
parseKeyboardEvent
rawHotkeyToParsedHotkey
resolveModifier
validateHotkey
Edit on GitHub
Previous
Formatting & Display
Next
React Hooks
On this page
@tanstack/hotkeys
Classes
Interfaces
Type Aliases
Variables
Functions
Learn about TanStack Ads
Hide Ads
Partners
Become a Partner
Learn about TanStack Ads
Hide Ads