getHotkeyHint

function getHotkeyHint(hotkey, options?): SvelteHotkeyHint;

Defined in: packages/svelte-hotkeys/src/getHotkeyHint.svelte.ts:31

Returns an object with a reactive visible getter indicating whether held modifiers reveal this shortcut. The hint shows only while the hotkey can fire: some registration of it is enabled and in an active scope. Pass getters to track changing hotkeys and options. A sequence reveals its hint from its first step, and an app hotkey matches its registrations by id and uses its effective hotkey (false while unbound). No hotkey (undefined, null, or '') returns false. This helper does not register a shortcut. A hotkey on an element counts only while focus is inside it.

Parameters#

hotkey#

MaybeGetter< | RegisterableHotkey | AppHotkey<string, HotkeyChord | HotkeySequence | null> | null | undefined>

options?#

MaybeGetter<HeldModifierOptions> = {}

Returns#

SvelteHotkeyHint