Data & State Management

Resources

BlogRelease notes, architecture notes, and essays.YouTubeThe official TanStack channel.

Workshops

Learn from maintainers

Remote and in-person TanStack workshops for teams that need depth.

Professional Workshops

Channels

DiscordCommunity support and real-time discussion.GitHubSource, issues, discussions, and releases.

People & Work

MaintainersMeet the people maintaining the stack.ContributorsCore, library, and community contributors.ShowcaseProducts and teams building with TanStack.

Tools

BuilderAlphaGenerate TanStack app starters.StatsNPM and ecosystem usage data.

Recent Products

All MerchBrowse all TanStack apparel, accessories, and stickers.

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 think about open source and products.TenetsThe values that shape TanStack libraries.Brand GuideLogos, colors, and brand usage.

Partners

Work with TanStack

Sponsorships, placements, and partner pages.

Partnership Inquiry

All LibrariesBrowse the full set of public packages.

Framework

Data & State Management

UI & UX

Performance

Tooling

Resources

BlogRelease notes, architecture notes, and essays.YouTubeThe official TanStack channel.

Professional Workshops

Channels

DiscordCommunity support and real-time discussion.GitHubSource, issues, discussions, and releases.

People & Work

MaintainersMeet the people maintaining the stack.ContributorsCore, library, and community contributors.ShowcaseProducts and teams building with TanStack.

Tools

BuilderAlphaGenerate TanStack app starters.StatsNPM and ecosystem usage data.

Recent Products

All MerchBrowse all TanStack apparel, accessories, and stickers.

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 think about open source and products.TenetsThe values that shape TanStack libraries.Brand GuideLogos, colors, and brand usage.

Partnership Inquiry

Docs

API Reference

Core API
Adapter API
React Hooks

Hotkeys API Reference

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

Menu

Home Get Started Guides API Examples

API Reference

Core API
Adapter API
React Hooks

Hotkeys API Reference

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/framework/react/reference/index.md

API Reference

@tanstack/react-hotkeys

Interfaces

HotkeysProviderOptions
HotkeysProviderProps
ReactHotkeyRecorder
UseCustomHotkeysResult

Type Aliases

UseAppHotkeyOptions
UseHotkeyChordOptions
UseHotkeyCommonOptions
UseHotkeyDefinition
UseHotkeyOptions
UseHotkeyOptionsFor
UseHotkeySequenceOptions
UseHotkeyTarget

Functions

HotkeysProvider
useAppHotkeyList
useAppHotkeys
useCustomHotkeys
useDefaultHotkeysOptions
useHeldKeyCodes
useHeldKeys
useHotkey
useHotkeyHint
useHotkeyRecorder
useHotkeyRegistrations
useHotkeys
useHotkeysContext
useKeyHold

PreviousAdapter API

NextHotkeyManager

On this page

Interfaces
Type Aliases
Functions

@Tan_Stack on X.com

@TannerLinsley on X.com

Nozzle.io - Keyword Rank Tracker

Terms of Service

© 2026 TanStack LLC

Partners Become a Partner

Gold

Lovable

Lovable

CodeRabbit

CodeRabbit

Cloudflare

Cloudflare

Railway

Railway

Silver

SerpAPI

SerpAPI

Netlify

Netlify

OpenRouter

OpenRouter

AG Grid

AG Grid

WorkOS

WorkOS

Bronze

Electric

Electric

Sentry

Sentry

Unkey

Unkey

Prisma

Prisma

TanStack Start and TanStack AI Win 2026 Open Source AwardsJun 22, 2026 How an Underrated Refactor Saved 90% Memory UsageJun 22, 2026 TypeScript Performance in TanStack Table V9Jun 14, 2026