createHotkey

Call Signature

function createHotkey<T>(
   hotkey, 
   callback, 
   options?): void;

Defined in: createHotkey.ts:66

Solid primitive for registering a hotkey: a chord such as 'Mod+S', a sequence such as ['G', 'G'], or an app hotkey from defineAppHotkeys. The hotkey and options may be accessors.

Chords accept requireReset; sequences accept timeout. A one-step sequence registers as its chord. An app hotkey uses its effective hotkey from HotkeysProvider (including the user's custom hotkey) and its declared meta and options, and registers nothing while unbound. undefined, null, or '' registers nothing, for an optional shortcut.

Type Parameters

T

T extends AppHotkey<string, HotkeyChord | HotkeySequence | null>

Parameters

hotkey

MaybeAccessor<T | null | undefined>

callback

HotkeyCallback

options?

MaybeAccessor<CreateAppHotkeyOptions<T>>

Returns

void

Example

tsx

createHotkey('Mod+S', () => save())
createHotkey(['G', 'G'], () => scrollToTop(), { timeout: 500 })
createHotkey('Escape', () => close(), () => ({ enabled: isOpen() }))