TanStack
Hotkeys v0v0
Framework
StartRouter
Data & State
QueryDBStoreAI
UI & UX
TableChartsFormHotkeysMarkdownHighlight
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
Partnership Inquiry
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.
Partnership Inquiry
Docs
API Reference
  • Core API
  • Adapter API
  • React Hooks
Hotkeys API Reference
  • HotkeyManager
  • getHotkeyManager
  • HotkeyScopesState
  • Hotkey
  • HotkeyChord
  • HotkeySequence
  • RegisterableHotkey
  • RegisterableHotkeyChord
  • RegisterableHotkeySequence
  • RawHotkeyChord
  • HotkeyOptions
  • HotkeyChordOptions
  • HotkeySequenceOptions
  • HotkeyOptionsFor
  • HotkeyRegistrationHandle
  • HotkeyRegistrationView
  • HotkeyChordRegistrationView
  • HotkeySequenceRegistrationView
  • HotkeyRegistrationStatus
  • toHotkeyRegistrationView
  • HotkeyCallback
  • HotkeyCallbackContext
  • HotkeyChordCallbackContext
  • HotkeySequenceCallbackContext
  • HotkeyCallbackContextFor
  • HotkeyMeta
  • ConflictBehavior
  • isHotkeySequence
  • simplifyHotkey
  • createSequenceMatcher
  • DEFAULT_SEQUENCE_TIMEOUT
  • AppHotkeysProvider
  • HotkeysProvider
  • useDefaultHotkeysOptions
  • useFormatForDisplay
  • useHotkey
  • useHotkeyRegistrations
  • useHotkeyScopesState
  • useHotkeys
  • useHotkeysContext
  • AppHotkeysProviderProps
  • HotkeysProviderOptions
  • HotkeysProviderProps
  • UseHotkeyChordOptions
  • UseHotkeyCommonOptions
  • UseHotkeyDefinition
  • UseHotkeyOptions
  • UseHotkeyOptionsFor
  • UseHotkeySequenceOptions
  • UseHotkeyTarget
App Hotkeys API Reference
  • defineAppHotkeys
  • AppHotkeysStore
  • installAppHotkeysStore
  • 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
  • detectPlatform
  • HotkeyPlatform
  • 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
  • HotkeyScopesState
  • Hotkey
  • HotkeyChord
  • HotkeySequence
  • RegisterableHotkey
  • RegisterableHotkeyChord
  • RegisterableHotkeySequence
  • RawHotkeyChord
  • HotkeyOptions
  • HotkeyChordOptions
  • HotkeySequenceOptions
  • HotkeyOptionsFor
  • HotkeyRegistrationHandle
  • HotkeyRegistrationView
  • HotkeyChordRegistrationView
  • HotkeySequenceRegistrationView
  • HotkeyRegistrationStatus
  • toHotkeyRegistrationView
  • HotkeyCallback
  • HotkeyCallbackContext
  • HotkeyChordCallbackContext
  • HotkeySequenceCallbackContext
  • HotkeyCallbackContextFor
  • HotkeyMeta
  • ConflictBehavior
  • isHotkeySequence
  • simplifyHotkey
  • createSequenceMatcher
  • DEFAULT_SEQUENCE_TIMEOUT
  • AppHotkeysProvider
  • HotkeysProvider
  • useDefaultHotkeysOptions
  • useFormatForDisplay
  • useHotkey
  • useHotkeyRegistrations
  • useHotkeyScopesState
  • useHotkeys
  • useHotkeysContext
  • AppHotkeysProviderProps
  • HotkeysProviderOptions
  • HotkeysProviderProps
  • UseHotkeyChordOptions
  • UseHotkeyCommonOptions
  • UseHotkeyDefinition
  • UseHotkeyOptions
  • UseHotkeyOptionsFor
  • UseHotkeySequenceOptions
  • UseHotkeyTarget
App Hotkeys API Reference
  • defineAppHotkeys
  • AppHotkeysStore
  • installAppHotkeysStore
  • 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
  • detectPlatform
  • HotkeyPlatform
  • 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/type-aliases/IndividualKey.md
Key hold & held keys API Reference

IndividualKey

ts
type IndividualKey = CanonicalModifier | Key;

Defined in: key.types.ts:258

Includes both modifier keys and regular keys.

Edit on GitHub
PreviousKeyStateTrackerState
NextmatchesHeldModifiers
Blog
@Tan_Stack on X.com
@TannerLinsley on X.com
GitHub
YouTube
Ethos
Tenets
Privacy Policy
Terms of Service
© 2026 TanStack LLC
PartnersBecome a Partner
Gold
LovableLovable
CloudflareCloudflare
NetlifyNetlify
CodeRabbitCodeRabbit
RailwayRailway
Silver
OpenRouterOpenRouter
AG GridAG Grid
WorkOSWorkOS
ClerkClerk
SerpApiSerpApi
Bronze
ElectricElectric
SentrySentry
UnkeyUnkey
PrismaPrisma
Latest Posts