createHotkeys

function createHotkeys(hotkeys, commonOptions?): void;

Defined in: createHotkeys.ts:39

Solid primitive for registering several hotkeys at once: chords, sequences, and app hotkeys. Pass an accessor for a reactive list.

Options merge in this order: provider defaults, app hotkey declaration, commonOptions, per-hotkey options. Each option applies only to the kinds that support it. Unbound app hotkeys and empty sequences register nothing. A null target skips registration until it is set.

Parameters#

hotkeys#

| readonly CreateHotkeyDefinition[] | (() => readonly CreateHotkeyDefinition[])

commonOptions?#

| CreateHotkeyCommonOptions | (() => CreateHotkeyCommonOptions)

Returns#

void

Example#

createHotkeys([
  { hotkey: 'Mod+S', callback: () => save() },
  { hotkey: ['G', 'G'], callback: () => scrollToTop(), options: { timeout: 500 } },
])