TanStack
Hotkeys v0v0
Docs
Cloudflare
Railway
CodeRabbit
Clerk
OpenRouter
WorkOS
AG Grid
Netlify
SerpAPI
Electric
Sentry
Prisma
Unkey
Cloudflare
Railway
CodeRabbit
Clerk
OpenRouter
WorkOS
AG Grid
Netlify
SerpAPI
Electric
Sentry
Prisma
Unkey
Menu
Getting Started
Guides
API Reference
Hotkeys API Reference
Hotkey Sequence API Reference
Key hold & held keys API Reference
Hotkey Recorder API Reference
Hotkey Sequence Recorder API Reference
Normalization & format API Reference
Examples
Key hold & held keys API Reference

getHeldKeys

Function: getHeldKeys()

ts
function getHeldKeys(): SvelteHeldKeys;
function getHeldKeys(): SvelteHeldKeys;

Defined in: packages/svelte-hotkeys/src/getHeldKeys.svelte.ts:38

Svelte function that returns reactive access to currently held keyboard keys.

This function uses the global KeyStateTracker and updates whenever keys are pressed or released.

Returns

SvelteHeldKeys

Object with a reactive keys property

Example

svelte
<script>
  import { getHeldKeys } from '@tanstack/svelte-hotkeys'

  const heldKeys = getHeldKeys()
</script>
<div>
  Currently pressed: {heldKeys.keys.join(' + ') || 'None'}
</div>
<script>
  import { getHeldKeys } from '@tanstack/svelte-hotkeys'

  const heldKeys = getHeldKeys()
</script>
<div>
  Currently pressed: {heldKeys.keys.join(' + ') || 'None'}
</div>
Edit on GitHub
SvelteHeldKeyState
SvelteHeldKeys
© 2026 TanStack LLC