Libraries
Framework
Start
Router
Data & State
Query
DB
Store
AI
UI
Table
Charts
Form
Markdown
Highlight
UX
Virtual
Pacer
Hotkeys
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
TanChat
NEW
Tools
Tools
Application Starter
Alpha
Generate TanStack app starters.
Stats
NPM and ecosystem usage data.
Merch
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
TanChat
NEW
Tools
Merch
Support
Search
Ask AI
Sign In
Back
Hotkeys Docs
React
v0
Latest
Search...
K
Home
Get Started
Guides
API
Examples
Getting Started
Overview
Installation
Devtools
Quick Start
Hotkeys
Menu
Menu
Home
Get Started
Guides
API
Examples
React
v0
Latest
Getting Started
Overview
Installation
Devtools
Quick Start
AI/LLM: This documentation page is available in plain markdown format at/hotkeys/latest/docs/reference.md
@tanstack/hotkeys
Copy page
Classes
#
AppHotkeysStore
HotkeyManager
HotkeyRecorder
KeyStateTracker
Interfaces
#
AppHotkey
AppHotkeyInput
AppHotkeyListItem
AppHotkeysState
AppHotkeysStoreOptions
CreateHotkeyHandlerOptions
FormatDisplayOptions
HeldModifierOptions
HotkeyCallbackContext
HotkeyChordOptions
HotkeyChordRecorderOptions
HotkeyChordRegistration
HotkeyChordRegistrationView
HotkeyConflict
HotkeyConflictOptions
HotkeyMeta
HotkeyOptions
HotkeyRecorderState
HotkeyRecorderValidationContext
HotkeyRegistrationHandle
HotkeySequenceOptions
HotkeySequenceRecorderOptions
HotkeySequenceRegistration
HotkeySequenceRegistrationView
KeyboardEventMatch
KeyStateTrackerState
NormalizedKeyboardEvent
ParsedModifiers
RawModifiers
RecorderOptions
RecorderRejection
Register
ValidationResult
Type Aliases
#
AppHotkeyChordOptions
AppHotkeyDefaultKind
AppHotkeyId
AppHotkeyOptions
AppHotkeys
AppHotkeySequenceOptions
AppHotkeyStatus
CanonicalModifier
ConflictBehavior
CustomHotkeys
DefinedAppHotkeys
DisplayHotkey
DisplayHotkeyChord
EditingKey
FourModifierHotkey
FunctionKey
Hotkey
HotkeyCallback
HotkeyChord
HotkeyOptionsFor
HotkeyRecorderCommitKeys
HotkeyRecorderOptions
HotkeyRegistration
HotkeyRegistrationView
HotkeySequence
IndividualKey
Key
LetterKey
LogicalKey
Modifier
MultiHotkeyHandler
NamedKey
NavigationKey
NonPunctuationKey
NumberKey
ParsedHotkey
PhysicalKey
PhysicalKeyCode
PunctuationKey
RawHotkey
RecorderKeyMode
RegisterableHotkey
RegisterableHotkeyChord
RegisteredAppHotkeys
SingleModifierHotkey
Target
ThreeModifierHotkey
TwoModifierHotkey
ValidatableHotkey
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
defineAppHotkeys
detectPlatform
findHotkeyConflicts
formatForDisplay
formatHotkey
getAppHotkeyRegistrationOptions
getHotkeyManager
getKeyStateTracker
hasNonModifierKey
isAppHotkey
isCustomHotkey
isHotkeySequence
isModifierKey
isSingleLetterKey
matchesHeldModifiers
matchesKeyboardEvent
normalizeHotkey
normalizeHotkeyFromEvent
normalizeHotkeyFromParsed
normalizeKeyName
normalizeRegisterableHotkey
parseHotkey
parseKeyboardEvent
parseRegisterableHotkey
provideAppHotkeys
publishAppHotkeysStore
rawHotkeyToParsedHotkey
resolveAppHotkey
resolveModifier
simplifyHotkey
toHotkeyRegistrationView
validateHotkey
Edit on GitHub
Next
Overview
On this page
Classes
Interfaces
Type Aliases
Variables
Functions
Partners
Become a Partner
Gold
Silver
Bronze
Latest Posts