Key hold & held keys API Reference

getHeldKeys

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

PreviousgetHeldKeyCodesMap

NextgetHotkeyHint

Blog

@Tan_Stack on X.com

@TannerLinsley on X.com

GitHub

YouTube

Nozzle.io - Keyword Rank Tracker

Ethos

Tenets