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
API Reference
Core API
Adapter API
React Hooks
Hotkeys API Reference
HotkeyManager
getHotkeyManager
Hotkey
HotkeyChord
HotkeySequence
RegisterableHotkey
RegisterableHotkeyChord
RawHotkey
HotkeyOptions
HotkeyChordOptions
HotkeySequenceOptions
HotkeyOptionsFor
HotkeyRegistrationHandle
HotkeyRegistrationView
HotkeyChordRegistrationView
HotkeySequenceRegistrationView
toHotkeyRegistrationView
HotkeyCallback
HotkeyCallbackContext
HotkeyMeta
ConflictBehavior
isHotkeySequence
simplifyHotkey
createSequenceMatcher
DEFAULT_SEQUENCE_TIMEOUT
HotkeysProvider
useDefaultHotkeysOptions
useHotkey
useHotkeyRegistrations
useHotkeys
useHotkeysContext
HotkeysProviderOptions
HotkeysProviderProps
UseHotkeyChordOptions
UseHotkeyCommonOptions
UseHotkeyDefinition
UseHotkeyOptions
UseHotkeyOptionsFor
UseHotkeySequenceOptions
UseHotkeyTarget
App Hotkeys API Reference
defineAppHotkeys
AppHotkeysStore
provideAppHotkeys
publishAppHotkeysStore
AppHotkey
AppHotkeyInput
AppHotkeyOptions
AppHotkeyListItem
AppHotkeyStatus
AppHotkeysState
AppHotkeysStoreOptions
CustomHotkeys
Register
AppHotkeyId
RegisteredAppHotkeys
isAppHotkey
isCustomHotkey
resolveAppHotkey
useAppHotkeyList
useAppHotkeys
useCustomHotkeys
UseCustomHotkeysResult
UseAppHotkeyOptions
Key hold & held keys API Reference
KeyStateTracker
getKeyStateTracker
KeyStateTrackerState
IndividualKey
matchesHeldModifiers
HeldModifierOptions
useHeldKeyCodes
useHeldKeys
useHotkeyHint
useKeyHold
Hotkey Recorder API Reference
HotkeyRecorder
HotkeyRecorderOptions
HotkeyChordRecorderOptions
HotkeySequenceRecorderOptions
HotkeyRecorderState
HotkeyRecorderCommitKeys
HotkeyRecorderValidationContext
RecorderOptions
RecorderRejection
RecorderKeyMode
findHotkeyConflicts
HotkeyConflict
HotkeyConflictOptions
useHotkeyRecorder
ReactHotkeyRecorder
Normalization & format API Reference
formatForDisplay
FormatDisplayOptions
DisplayHotkey
DisplayHotkeyChord
formatHotkey
normalizeHotkey
normalizeHotkeyFromParsed
normalizeHotkeyFromEvent
normalizeRegisterableHotkey
parseHotkey
parseRegisterableHotkey
parseKeyboardEvent
rawHotkeyToParsedHotkey
ParsedHotkey
matchesKeyboardEvent
areHotkeysEqual
validateHotkey
checkHotkey
assertValidHotkey
ValidationResult
ValidatableHotkey
LogicalKey
PhysicalKey
PhysicalKeyCode
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
Hotkeys
Menu
Menu
Home
Get Started
Guides
API
Examples
React
v0
Latest
API Reference
Core API
Adapter API
React Hooks
Hotkeys API Reference
HotkeyManager
getHotkeyManager
Hotkey
HotkeyChord
HotkeySequence
RegisterableHotkey
RegisterableHotkeyChord
RawHotkey
HotkeyOptions
HotkeyChordOptions
HotkeySequenceOptions
HotkeyOptionsFor
HotkeyRegistrationHandle
HotkeyRegistrationView
HotkeyChordRegistrationView
HotkeySequenceRegistrationView
toHotkeyRegistrationView
HotkeyCallback
HotkeyCallbackContext
HotkeyMeta
ConflictBehavior
isHotkeySequence
simplifyHotkey
createSequenceMatcher
DEFAULT_SEQUENCE_TIMEOUT
HotkeysProvider
useDefaultHotkeysOptions
useHotkey
useHotkeyRegistrations
useHotkeys
useHotkeysContext
HotkeysProviderOptions
HotkeysProviderProps
UseHotkeyChordOptions
UseHotkeyCommonOptions
UseHotkeyDefinition
UseHotkeyOptions
UseHotkeyOptionsFor
UseHotkeySequenceOptions
UseHotkeyTarget
App Hotkeys API Reference
defineAppHotkeys
AppHotkeysStore
provideAppHotkeys
publishAppHotkeysStore
AppHotkey
AppHotkeyInput
AppHotkeyOptions
AppHotkeyListItem
AppHotkeyStatus
AppHotkeysState
AppHotkeysStoreOptions
CustomHotkeys
Register
AppHotkeyId
RegisteredAppHotkeys
isAppHotkey
isCustomHotkey
resolveAppHotkey
useAppHotkeyList
useAppHotkeys
useCustomHotkeys
UseCustomHotkeysResult
UseAppHotkeyOptions
Key hold & held keys API Reference
KeyStateTracker
getKeyStateTracker
KeyStateTrackerState
IndividualKey
matchesHeldModifiers
HeldModifierOptions
useHeldKeyCodes
useHeldKeys
useHotkeyHint
useKeyHold
Hotkey Recorder API Reference
HotkeyRecorder
HotkeyRecorderOptions
HotkeyChordRecorderOptions
HotkeySequenceRecorderOptions
HotkeyRecorderState
HotkeyRecorderCommitKeys
HotkeyRecorderValidationContext
RecorderOptions
RecorderRejection
RecorderKeyMode
findHotkeyConflicts
HotkeyConflict
HotkeyConflictOptions
useHotkeyRecorder
ReactHotkeyRecorder
Normalization & format API Reference
formatForDisplay
FormatDisplayOptions
DisplayHotkey
DisplayHotkeyChord
formatHotkey
normalizeHotkey
normalizeHotkeyFromParsed
normalizeHotkeyFromEvent
normalizeRegisterableHotkey
parseHotkey
parseRegisterableHotkey
parseKeyboardEvent
rawHotkeyToParsedHotkey
ParsedHotkey
matchesKeyboardEvent
areHotkeysEqual
validateHotkey
checkHotkey
assertValidHotkey
ValidationResult
ValidatableHotkey
LogicalKey
PhysicalKey
PhysicalKeyCode
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
AI/LLM: This documentation page is available in plain markdown format at/hotkeys/latest/docs/reference/adapter/index.md
API Reference
On this page
@tanstack/hotkeys
Copy page
Interfaces
#
PrepareHotkeyDefinitionsOptions
Type Aliases
#
AdapterAppHotkeyOptions
AdapterChordOptions
AdapterCommonOptions
AdapterHotkeyDefinition
AdapterHotkeyOptions
AdapterOptionsFor
AdapterSequenceOptions
HotkeyBindingsCommonOptions
HotkeyDefinition
WithTarget
Functions
#
createHotkeyBindings
prepareHotkeyDefinitions
subscribePublishedAppHotkeys
Edit on GitHub
Previous
Core API
Next
React Hooks
On this page
Interfaces
Type Aliases
Functions
Partners
Become a Partner
Gold
Silver
Bronze
Latest Posts