TanStack
Hotkeys
v0
v0
Libraries
Framework
Start
RC
Docs
Router
Docs
Data & State Management
Query
Docs
DB
beta
Docs
Store
alpha
Docs
AI
beta
Docs
UI & UX
Table
Docs
Form
new
Docs
Hotkeys
alpha
Docs
Performance
Virtual
Docs
Pacer
beta
Docs
Tooling
Devtools
alpha
Docs
Config
Docs
CLI
alpha
Docs
Intent
alpha
Docs
Learn
Resources
Blog
Release notes, architecture notes, and essays.
YouTube
The official TanStack channel.
Community
Channels
Discord
Community support and real-time discussion.
GitHub
Source, issues, discussions, and releases.
People & Work
Maintainers
Meet the people maintaining the stack.
Contributors
Core, library, and community contributors.
Showcase
Products and teams building with TanStack.
Tools
Tools
Builder
Alpha
Generate TanStack app starters.
Stats
NPM and ecosystem usage data.
Merch
Recent Products
All Merch
Browse all TanStack apparel, accessories, and stickers.
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 think about open source and products.
Tenets
The values that shape TanStack libraries.
Brand Guide
Logos, colors, and brand usage.
Search
AI
Ask AI
Log In
Log In
Libraries
All Libraries
Browse the full set of public packages.
Framework
Start
RC
Docs
Router
Docs
Data & State Management
Query
Docs
DB
beta
Docs
Store
alpha
Docs
AI
beta
Docs
UI & UX
Table
Docs
Form
new
Docs
Hotkeys
alpha
Docs
Performance
Virtual
Docs
Pacer
beta
Docs
Tooling
Devtools
alpha
Docs
Config
Docs
CLI
alpha
Docs
Intent
alpha
Docs
Learn
Resources
Blog
Release notes, architecture notes, and essays.
YouTube
The official TanStack channel.
Professional Workshops
Community
Channels
Discord
Community support and real-time discussion.
GitHub
Source, issues, discussions, and releases.
People & Work
Maintainers
Meet the people maintaining the stack.
Contributors
Core, library, and community contributors.
Showcase
Products and teams building with TanStack.
Tools
Tools
Builder
Alpha
Generate TanStack app starters.
Stats
NPM and ecosystem usage data.
Merch
Recent Products
All Merch
Browse all TanStack apparel, accessories, and stickers.
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 think about open source and products.
Tenets
The values that shape TanStack libraries.
Brand Guide
Logos, colors, and brand usage.
Partnership Inquiry
Docs
Svelte
Latest
Search...
K
API Reference
Core API
Svelte APIs
Hotkeys API Reference
HotkeyManager
getHotkeyManager
HotkeyOptions
HotkeyRegistration
HotkeyRegistrationHandle
HotkeyCallback
HotkeyCallbackContext
HotkeyMeta
HotkeyRegistrationView
toHotkeyRegistrationView
ConflictBehavior
createHotkey
createHotkeys
createHotkeyAttachment
createHotkeysAttachment
CreateHotkeyOptions
CreateHotkeyDefinition
HotkeysProvider
HotkeysProviderOptions
HotkeysProviderProps
DEFAULT_OPTIONS
getDefaultHotkeysOptions
getHotkeysContext
setHotkeysContext
getHotkeyRegistrations
SvelteHotkeyRegistrations
Hotkey Sequence API Reference
SequenceManager
getSequenceManager
SequenceOptions
createSequenceMatcher
HotkeySequence
SequenceRegistrationHandle
SequenceRegistrationView
createHotkeySequence
createHotkeySequenceAttachment
CreateHotkeySequenceOptions
createHotkeySequences
createHotkeySequencesAttachment
CreateHotkeySequenceDefinition
Key hold & held keys API Reference
KeyStateTracker
getKeyStateTracker
KeyStateTrackerState
IndividualKey
getIsKeyHeld
SvelteHeldKeyState
getHeldKeys
SvelteHeldKeys
getHeldKeyCodesMap
SvelteHeldKeyCodesMap
Hotkey Recorder API Reference
HotkeyRecorder
HotkeyRecorderOptions
HotkeyRecorderState
createHotkeyRecorder
SvelteHotkeyRecorder
Hotkey Sequence Recorder API Reference
HotkeySequenceRecorder
HotkeySequenceRecorderOptions
HotkeySequenceRecorderState
HotkeySequenceRecorderCommitKeys
createHotkeySequenceRecorder
SvelteHotkeySequenceRecorder
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
Menu
Menu
Home
Get Started
Guides
API
Examples
Svelte
Latest
API Reference
Core API
Svelte APIs
Hotkeys API Reference
HotkeyManager
getHotkeyManager
HotkeyOptions
HotkeyRegistration
HotkeyRegistrationHandle
HotkeyCallback
HotkeyCallbackContext
HotkeyMeta
HotkeyRegistrationView
toHotkeyRegistrationView
ConflictBehavior
createHotkey
createHotkeys
createHotkeyAttachment
createHotkeysAttachment
CreateHotkeyOptions
CreateHotkeyDefinition
HotkeysProvider
HotkeysProviderOptions
HotkeysProviderProps
DEFAULT_OPTIONS
getDefaultHotkeysOptions
getHotkeysContext
setHotkeysContext
getHotkeyRegistrations
SvelteHotkeyRegistrations
Hotkey Sequence API Reference
SequenceManager
getSequenceManager
SequenceOptions
createSequenceMatcher
HotkeySequence
SequenceRegistrationHandle
SequenceRegistrationView
createHotkeySequence
createHotkeySequenceAttachment
CreateHotkeySequenceOptions
createHotkeySequences
createHotkeySequencesAttachment
CreateHotkeySequenceDefinition
Key hold & held keys API Reference
KeyStateTracker
getKeyStateTracker
KeyStateTrackerState
IndividualKey
getIsKeyHeld
SvelteHeldKeyState
getHeldKeys
SvelteHeldKeys
getHeldKeyCodesMap
SvelteHeldKeyCodesMap
Hotkey Recorder API Reference
HotkeyRecorder
HotkeyRecorderOptions
HotkeyRecorderState
createHotkeyRecorder
SvelteHotkeyRecorder
Hotkey Sequence Recorder API Reference
HotkeySequenceRecorder
HotkeySequenceRecorderOptions
HotkeySequenceRecorderState
HotkeySequenceRecorderCommitKeys
createHotkeySequenceRecorder
SvelteHotkeySequenceRecorder
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/svelte/reference/index.md
API Reference
On this page
@tanstack/svelte-hotkeys
Copy page
@tanstack/svelte-hotkeys
#
Interfaces
#
CreateHotkeyDefinition
CreateHotkeyOptions
CreateHotkeySequenceDefinition
CreateHotkeySequenceOptions
HotkeysProviderOptions
HotkeysProviderProps
SvelteHeldKeyCodesMap
SvelteHeldKeys
SvelteHeldKeyState
SvelteHotkeyRecorder
SvelteHotkeyRegistrations
SvelteHotkeySequenceRecorder
Type Aliases
#
HotkeysProvider
Variables
#
DEFAULT_OPTIONS
HotkeysProvider
Functions
#
createHotkey
createHotkeyAttachment
createHotkeyRecorder
createHotkeys
createHotkeysAttachment
createHotkeySequence
createHotkeySequenceAttachment
createHotkeySequenceRecorder
createHotkeySequences
createHotkeySequencesAttachment
getDefaultHotkeysOptions
getHeldKeyCodesMap
getHeldKeys
getHotkeyRegistrations
getHotkeysContext
getIsKeyHeld
setHotkeysContext
Edit on GitHub
Previous
Core API
Next
HotkeyManager
On this page
@tanstack/svelte-hotkeys
Interfaces
Type Aliases
Variables
Functions
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
Partners
Become a Partner
Gold
Silver
Bronze