Hotkeys API Reference

getHotkeyRegistrations

Function: getHotkeyRegistrations()

function getHotkeyRegistrations(): SvelteHotkeyRegistrations;

Defined in: packages/svelte-hotkeys/src/getHotkeyRegistrations.svelte.ts:58

Svelte function that returns reactive access to all hotkey and sequence registrations from the singleton managers.

This is a standalone function that does NOT require the HotkeysProvider.

Returns

SvelteHotkeyRegistrations

Object with reactive hotkeys and sequences properties

Example

svelte

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

  const registrations = getHotkeyRegistrations()
</script>
{#each registrations.hotkeys as reg}
  <div>{reg.options.meta?.name} — {reg.triggerCount} triggers</div>
{/each}

Edit on GitHub

PrevioussetHotkeysContext

NextSvelteHotkeyRegistrations

Blog

@Tan_Stack on X.com

@TannerLinsley on X.com

GitHub

YouTube

Nozzle.io - Keyword Rank Tracker

Ethos

Tenets