TanStackHotkeys
Framework
StartRouter
Data & State
QueryDBStoreAI
UI
TableChartsFormMarkdownHighlight
UX
VirtualPacerHotkeys
Tooling
DevtoolsConfigCLIIntent
Blog
Blog & Release Notes
About
YouTubeThe official TanStack channel.WorkshopsLive sessions from the maintainers.Release NotesThe latest releases and changelog.
Channels
DiscordReal-time community support.GitHubSource, issues, discussions, and releases.
People & Work
MaintainersMeet the people maintaining the stack.ShowcaseProjects selected by the TanStack team.Community projects
TanChatNEW
Tools
Application StarterAlphaGenerate TanStack app starters.StatsNPM and ecosystem usage data.
Merch
Support
Support OverviewFind the right support path.PartnersCompanies supporting TanStack.OSS SponsorsSponsors keeping TanStack open source.Enterprise SupportPrivate consulting and expert support.ContactGet in touch with the TanStack team.
About
EthosHow we approach open source.TenetsThe values that shape TanStack libraries.Design SystemLogos, tokens, and UI components.
Partners

Sponsorships, placements, and partner pages.

Work with
TanStack
Partnership Inquiry
Sign In
Hotkeys Docs
  • Home
  • Get Started
  • Guides
  • API
  • Examples
API Reference
  • Core API
  • Adapter API
  • React Hooks
Hotkeys API Reference
  • HotkeyManager
  • getHotkeyManager
  • Hotkey
  • HotkeyChord
  • HotkeySequence
  • RegisterableHotkey
  • RegisterableHotkeyChord
  • RegisterableHotkeySequence
  • RawHotkeyChord
  • HotkeyOptions
  • HotkeyChordOptions
  • HotkeySequenceOptions
  • HotkeyOptionsFor
  • HotkeyRegistrationHandle
  • HotkeyRegistrationView
  • HotkeyChordRegistrationView
  • HotkeySequenceRegistrationView
  • toHotkeyRegistrationView
  • HotkeyCallback
  • HotkeyCallbackContext
  • HotkeyChordCallbackContext
  • HotkeySequenceCallbackContext
  • HotkeyCallbackContextFor
  • 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
  • HotkeyChordRecorderValidationContext
  • HotkeySequenceRecorderValidationContext
  • RecorderOptions
  • RecorderRejection
  • RecorderKeyMode
  • findHotkeyConflicts
  • HotkeyConflict
  • HotkeyConflictOptions
  • useHotkeyRecorder
  • ReactHotkeyRecorder
Normalization & format API Reference
  • formatForDisplay
  • FormatDisplayOptions
  • DisplayHotkey
  • DisplayHotkeyChord
  • formatHotkey
  • normalizeHotkey
  • parseHotkey
  • parseKeyboardEvent
  • ParsedHotkeyChord
  • 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
HomeGet StartedGuidesAPIExamples
API Reference
  • Core API
  • Adapter API
  • React Hooks
Hotkeys API Reference
  • HotkeyManager
  • getHotkeyManager
  • Hotkey
  • HotkeyChord
  • HotkeySequence
  • RegisterableHotkey
  • RegisterableHotkeyChord
  • RegisterableHotkeySequence
  • RawHotkeyChord
  • HotkeyOptions
  • HotkeyChordOptions
  • HotkeySequenceOptions
  • HotkeyOptionsFor
  • HotkeyRegistrationHandle
  • HotkeyRegistrationView
  • HotkeyChordRegistrationView
  • HotkeySequenceRegistrationView
  • toHotkeyRegistrationView
  • HotkeyCallback
  • HotkeyCallbackContext
  • HotkeyChordCallbackContext
  • HotkeySequenceCallbackContext
  • HotkeyCallbackContextFor
  • 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
  • HotkeyChordRecorderValidationContext
  • HotkeySequenceRecorderValidationContext
  • RecorderOptions
  • RecorderRejection
  • RecorderKeyMode
  • findHotkeyConflicts
  • HotkeyConflict
  • HotkeyConflictOptions
  • useHotkeyRecorder
  • ReactHotkeyRecorder
Normalization & format API Reference
  • formatForDisplay
  • FormatDisplayOptions
  • DisplayHotkey
  • DisplayHotkeyChord
  • formatHotkey
  • normalizeHotkey
  • parseHotkey
  • parseKeyboardEvent
  • ParsedHotkeyChord
  • 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

@tanstack/hotkeys

Interfaces#

  • HotkeysProviderScopeProps
  • PrepareHotkeyDefinitionsOptions

Type Aliases#

  • AdapterAppHotkeyOptions
  • AdapterChordOptions
  • AdapterCommonOptions
  • AdapterHotkeyDefinition
  • AdapterHotkeyOptions
  • AdapterOptionsFor
  • AdapterSequenceOptions
  • HotkeyBindingsCommonOptions
  • HotkeyDefinition
  • WithTarget

Functions#

  • activateHotkeysProviderScope
  • createHotkeyBindings
  • getHotkeysProviderScopeKey
  • mergeHotkeysProviderDefaults
  • prepareHotkeyDefinitions
  • subscribePublishedAppHotkeys
Edit on GitHub
PreviousCore API
NextReact Hooks

On this page

  • Interfaces
  • Type Aliases
  • Functions
PartnersBecome a Partner
Gold
RailwayRailway
NetlifyNetlify
CodeRabbitCodeRabbit
CloudflareCloudflare
LovableLovable
RenderRender
VercelVercel
Silver
AG GridAG Grid
WorkOSWorkOS
ClerkClerk
OpenRouterOpenRouter
SerpApiSerpApi
Bronze
PrismaPrisma
SentrySentry
UnkeyUnkey
Scarf
Latest Posts

The open source application stack for the web.

Libraries

  • Browse all
  • Query
  • Router
  • Start
  • Table
  • Form

Blog

  • Latest posts
  • Release notes
  • YouTube
  • Workshops

Community

  • Discord
  • GitHub
  • Maintainers
  • Showcase
  • Community projects

Tools

  • Builder
  • Stats

Merch

  • Shop
  • Cart

Support

  • Support overview
  • Partners
  • OSS sponsors
  • Enterprise support
  • Contact
  • Ethos
  • Tenets
  • Design system

© 2026 TanStack LLC

  • Privacy
  • Terms