TanStackTanStack
Hotkeys v0v0
Framework
StartRouter
Data & State
QueryDBStoreAI
UI & UX
TableFormHotkeys
Performance
VirtualPacer
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.ContributorsCore, library, and community contributors.ShowcaseTeams building with TanStack.
Tools
BuilderAlphaGenerate TanStack app starters.StatsNPM and ecosystem usage data.
Merch
View all
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
Get in touch
Log In
Log In
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.ContributorsCore, library, and community contributors.ShowcaseTeams building with TanStack.
Tools
BuilderAlphaGenerate TanStack app starters.StatsNPM and ecosystem usage data.
View all
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.
Get in touch
Docs
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
  • useKeyHold
  • useHeldKeys
  • useHeldKeyCodes
Hotkey Recorder API Reference
  • HotkeyRecorder
  • HotkeyRecorderOptions
  • HotkeyRecorderState
  • useHotkeyRecorder
  • ReactHotkeyRecorder
Hotkey Sequence Recorder API Reference
  • HotkeySequenceRecorder
  • HotkeySequenceRecorderOptions
  • HotkeySequenceRecorderState
  • HotkeySequenceRecorderCommitKeys
  • 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
HomeGet StartedGuidesAPIExamples
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
  • useKeyHold
  • useHeldKeys
  • useHeldKeyCodes
Hotkey Recorder API Reference
  • HotkeyRecorder
  • HotkeyRecorderOptions
  • HotkeyRecorderState
  • useHotkeyRecorder
  • ReactHotkeyRecorder
Hotkey Sequence Recorder API Reference
  • HotkeySequenceRecorder
  • HotkeySequenceRecorderOptions
  • HotkeySequenceRecorderState
  • HotkeySequenceRecorderCommitKeys
  • 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
AI/LLM: This documentation page is available in plain markdown format at/hotkeys/latest/docs/framework/react/reference/interfaces/HotkeysProviderProps.md
Hotkeys API Reference

HotkeysProviderProps

Interface: HotkeysProviderProps#

Defined in: HotkeysProvider.tsx:23

Properties#

children#

ts
children: ReactNode;

Defined in: HotkeysProvider.tsx:24


defaultOptions?#

ts
optional defaultOptions: HotkeysProviderOptions;

Defined in: HotkeysProvider.tsx:25

Edit on GitHub
PreviousHotkeysProvider
NextHotkeysProviderOptions

On this page

  • Interface: HotkeysProviderProps
  • Properties
  • children
  • defaultOptions?
Blog
@Tan_Stack on X.com
@TannerLinsley on X.com
GitHub
YouTube
Nozzle.io - Keyword Rank Tracker
Ethos
Tenets
Privacy Policy
Terms of Service
© 2026 TanStack LLC
PartnersBecome a Partner
Gold
CloudflareCloudflare
LovableLovable
CodeRabbitCodeRabbit
NetlifyNetlify
RailwayRailway
Silver
SerpApiSerpApi
AG GridAG Grid
OpenRouterOpenRouter
WorkOSWorkOS
ClerkClerk
Bronze
PrismaPrisma
UnkeyUnkey
ElectricElectric
SentrySentry
Latest Posts