Libraries
Framework
Start
Router
Data & State
Query
DB
Store
AI
UI & UX
Table
Charts
Form
Hotkeys
Markdown
Highlight
Performance
Virtual
Pacer
Tooling
Devtools
Config
CLI
Intent
Browse all libraries
Blog
Blog & Release Notes
About
YouTube
The official TanStack channel.
Workshops
Live sessions from the maintainers.
Release Notes
The latest releases and changelog.
Community
Channels
Discord
Real-time community support.
GitHub
Source, issues, discussions, and releases.
People & Work
Maintainers
Meet the people maintaining the stack.
Showcase
Projects selected by the TanStack team.
Community projects
Tools
Tools
Application Starter
Alpha
Generate TanStack app starters.
Builder
Alpha
Build and share TanStack projects.
Stats
NPM and ecosystem usage data.
Merch
View all
Support
Support
Support Overview
Find the right support path.
Partners
Companies supporting TanStack.
OSS Sponsors
Sponsors keeping TanStack open source.
Enterprise Support
Private consulting and expert support.
Contact
Get in touch with the TanStack team.
About
Ethos
How we approach open source.
Tenets
The values that shape TanStack libraries.
Design System
Logos, tokens, and UI components.
Search
Ask AI
Libraries
Blog
Community
Tools
Merch
Support
Search
Ask AI
Sign In
Back
Hotkeys Docs
React
v0
Latest
Search...
K
Home
Get Started
Guides
API
Examples
API Reference
Core API
React Hooks
Hotkeys API Reference
HotkeyManager
getHotkeyManager
HotkeyOptions
HotkeyRegistration
HotkeyRegistrationHandle
HotkeyCallback
HotkeyCallbackContext
HotkeyMeta
HotkeyRegistrationView
toHotkeyRegistrationView
ConflictBehavior
useHotkey
useHotkeys
useHotkeysContext
UseHotkeyOptions
UseHotkeyDefinition
HotkeysProvider
HotkeysProviderProps
HotkeysProviderOptions
useDefaultHotkeysOptions
useHotkeyRegistrations
HotkeyRegistrationsResult
Hotkey Sequence API Reference
SequenceManager
getSequenceManager
SequenceOptions
createSequenceMatcher
HotkeySequence
SequenceRegistrationHandle
SequenceRegistrationView
useHotkeySequence
UseHotkeySequenceOptions
useHotkeySequences
UseHotkeySequenceDefinition
Key hold & held keys API Reference
KeyStateTracker
getKeyStateTracker
KeyStateTrackerState
IndividualKey
matchesHeldModifiers
HeldModifierOptions
useKeyHold
useHeldKeys
useHeldKeyCodes
useHotkeyHint
Hotkey Recorder API Reference
HotkeyRecorder
HotkeyRecorderOptions
HotkeyRecorderState
findHotkeyConflicts
HotkeyConflictOptions
HotkeyConflict
RecorderRejection
RecorderKeyMode
RecorderOptions
HotkeyRecorderValidationContext
useHotkeyRecorder
ReactHotkeyRecorder
Hotkey Sequence Recorder API Reference
HotkeySequenceRecorder
HotkeySequenceRecorderOptions
HotkeySequenceRecorderState
HotkeySequenceRecorderCommitKeys
HotkeySequenceRecorderValidationContext
useHotkeySequenceRecorder
ReactHotkeySequenceRecorder
Normalization & format API Reference
normalizeHotkey
normalizeHotkeyFromParsed
normalizeHotkeyFromEvent
normalizeRegisterableHotkey
formatForDisplay
formatHotkey
formatWithLabels
FormatDisplayOptions
KEY_DISPLAY_SYMBOLS
PUNCTUATION_KEY_DISPLAY_LABELS
MAC_MODIFIER_SYMBOLS
MAC_MODIFIER_LABELS
WINDOWS_MODIFIER_LABELS
LINUX_MODIFIER_LABELS
MODIFIER_ALIASES
MODIFIER_ORDER
MODIFIER_KEYS
parseRegisterableHotkey
areHotkeysEqual
PhysicalKey
Hotkey
RegisterableHotkey
RawHotkey
ParsedHotkey
LogicalKey
PhysicalKeyCode
DisplayHotkey
formatHotkeySequence
parseHotkey
rawHotkeyToParsedHotkey
parseKeyboardEvent
matchesKeyboardEvent
validateHotkey
checkHotkey
assertValidHotkey
ValidationResult
Hotkeys
Menu
Menu
Home
Get Started
Guides
API
Examples
React
v0
Latest
API Reference
Core API
React Hooks
Hotkeys API Reference
HotkeyManager
getHotkeyManager
HotkeyOptions
HotkeyRegistration
HotkeyRegistrationHandle
HotkeyCallback
HotkeyCallbackContext
HotkeyMeta
HotkeyRegistrationView
toHotkeyRegistrationView
ConflictBehavior
useHotkey
useHotkeys
useHotkeysContext
UseHotkeyOptions
UseHotkeyDefinition
HotkeysProvider
HotkeysProviderProps
HotkeysProviderOptions
useDefaultHotkeysOptions
useHotkeyRegistrations
HotkeyRegistrationsResult
Hotkey Sequence API Reference
SequenceManager
getSequenceManager
SequenceOptions
createSequenceMatcher
HotkeySequence
SequenceRegistrationHandle
SequenceRegistrationView
useHotkeySequence
UseHotkeySequenceOptions
useHotkeySequences
UseHotkeySequenceDefinition
Key hold & held keys API Reference
KeyStateTracker
getKeyStateTracker
KeyStateTrackerState
IndividualKey
matchesHeldModifiers
HeldModifierOptions
useKeyHold
useHeldKeys
useHeldKeyCodes
useHotkeyHint
Hotkey Recorder API Reference
HotkeyRecorder
HotkeyRecorderOptions
HotkeyRecorderState
findHotkeyConflicts
HotkeyConflictOptions
HotkeyConflict
RecorderRejection
RecorderKeyMode
RecorderOptions
HotkeyRecorderValidationContext
useHotkeyRecorder
ReactHotkeyRecorder
Hotkey Sequence Recorder API Reference
HotkeySequenceRecorder
HotkeySequenceRecorderOptions
HotkeySequenceRecorderState
HotkeySequenceRecorderCommitKeys
HotkeySequenceRecorderValidationContext
useHotkeySequenceRecorder
ReactHotkeySequenceRecorder
Normalization & format API Reference
normalizeHotkey
normalizeHotkeyFromParsed
normalizeHotkeyFromEvent
normalizeRegisterableHotkey
formatForDisplay
formatHotkey
formatWithLabels
FormatDisplayOptions
KEY_DISPLAY_SYMBOLS
PUNCTUATION_KEY_DISPLAY_LABELS
MAC_MODIFIER_SYMBOLS
MAC_MODIFIER_LABELS
WINDOWS_MODIFIER_LABELS
LINUX_MODIFIER_LABELS
MODIFIER_ALIASES
MODIFIER_ORDER
MODIFIER_KEYS
parseRegisterableHotkey
areHotkeysEqual
PhysicalKey
Hotkey
RegisterableHotkey
RawHotkey
ParsedHotkey
LogicalKey
PhysicalKeyCode
DisplayHotkey
formatHotkeySequence
parseHotkey
rawHotkeyToParsedHotkey
parseKeyboardEvent
matchesKeyboardEvent
validateHotkey
checkHotkey
assertValidHotkey
ValidationResult
AI/LLM: This documentation page is available in plain markdown format at/hotkeys/latest/docs/reference/index.md
API Reference
On this page
@tanstack/hotkeys
Copy page
Classes
#
HotkeyManager
HotkeyRecorder
HotkeySequenceRecorder
KeyStateTracker
SequenceManager
Interfaces
#
CreateHotkeyHandlerOptions
FormatDisplayOptions
HeldModifierOptions
HotkeyCallbackContext
HotkeyConflictOptions
HotkeyMeta
HotkeyOptions
HotkeyRecorderOptions
HotkeyRecorderState
HotkeyRecorderValidationContext
HotkeyRegistration
HotkeyRegistrationHandle
HotkeyRegistrationView
HotkeySequenceRecorderOptions
HotkeySequenceRecorderState
HotkeySequenceRecorderValidationContext
KeyboardEventMatch
KeyStateTrackerState
NormalizedKeyboardEvent
ParsedModifiers
RawModifiers
RecorderOptions
RecorderRejection
SequenceOptions
SequenceRegistration
SequenceRegistrationHandle
SequenceRegistrationView
ValidationResult
Type Aliases
#
CanonicalModifier
ConflictBehavior
DisplayHotkey
EditingKey
FourModifierHotkey
FunctionKey
Hotkey
HotkeyCallback
HotkeyConflict
HotkeySequence
HotkeySequenceRecorderCommitKeys
IndividualKey
Key
LetterKey
LogicalKey
Modifier
MultiHotkeyHandler
NamedKey
NavigationKey
NonPunctuationKey
NumberKey
ParsedHotkey
PhysicalKey
PhysicalKeyCode
PunctuationKey
RawHotkey
RecorderKeyMode
RegisterableHotkey
SingleModifierHotkey
Target
ThreeModifierHotkey
TwoModifierHotkey
Variables
#
ALL_KEYS
DEFAULT_SEQUENCE_TIMEOUT
EDITING_KEYS
FUNCTION_KEYS
KEY_DISPLAY_SYMBOLS
LETTER_KEYS
LINUX_MODIFIER_LABELS
MAC_MODIFIER_LABELS
MAC_MODIFIER_SYMBOLS
MODIFIER_ALIASES
MODIFIER_KEYS
MODIFIER_ORDER
NAVIGATION_KEYS
NUMBER_KEYS
PUNCTUATION_CODE_MAP
PUNCTUATION_KEY_DISPLAY_LABELS
PUNCTUATION_KEYS
WINDOWS_MODIFIER_LABELS
Functions
#
areHotkeysEqual
assertValidHotkey
checkHotkey
createHotkeyHandler
createMultiHotkeyHandler
createSequenceMatcher
detectPlatform
findHotkeyConflicts
formatForDisplay
formatHotkey
formatHotkeySequence
formatWithLabels
getHotkeyManager
getKeyStateTracker
getSequenceManager
hasNonModifierKey
isModifierKey
isSingleLetterKey
matchesHeldModifiers
matchesKeyboardEvent
normalizeHotkey
normalizeHotkeyFromEvent
normalizeHotkeyFromParsed
normalizeKeyName
normalizeRegisterableHotkey
parseHotkey
parseKeyboardEvent
parseRegisterableHotkey
rawHotkeyToParsedHotkey
resolveModifier
toHotkeyRegistrationView
validateHotkey
Edit on GitHub
Next
React Hooks
On this page
Classes
Interfaces
Type Aliases
Variables
Functions
Partners
Become a Partner
Gold
Silver
Bronze
Latest Posts