Hotkeys API Reference

getHotkeyRegistrations

function getHotkeyRegistrations(): SvelteHotkeyRegistrations;

function getHotkeyRegistrations(): SvelteHotkeyRegistrations;

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

Svelte function that returns reactive access to every hotkey registration, chords and sequences, from the singleton HotkeyManager.

This function does NOT require the HotkeysProvider.

Returns

SvelteHotkeyRegistrations

Example

svelte

<script lang="ts">
  const registrations = getHotkeyRegistrations()
</script>

{#each registrations.hotkeys as reg (reg.id)}
  <li>{reg.options.meta?.name}: {formatForDisplay(reg.hotkey)}</li>
{/each}

<script lang="ts">
  const registrations = getHotkeyRegistrations()
</script>

{#each registrations.hotkeys as reg (reg.id)}
  <li>{reg.options.meta?.name}: {formatForDisplay(reg.hotkey)}</li>
{/each}

Edit on GitHub

PreviousgetDefaultHotkeysOptions

NextgetHotkeysContext

Blog

@Tan_Stack on X.com

@TannerLinsley on X.com

GitHub

YouTube

Nozzle.io - Keyword Rank Tracker

Ethos

Tenets