useHotkey

Call Signature#

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

Defined in: useHotkey.ts:48

Registers one hotkey: a chord such as 'Mod+S', a sequence such as ['G', 'G'], or an app hotkey from defineAppHotkeys. The callback and options are refreshed after every commit.

Type Parameters#

T#

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

Parameters#

hotkey#

T

callback#

HotkeyCallback

options?#

UseAppHotkeyOptions<T>

Returns#

void

Call Signature#

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

Defined in: useHotkey.ts:53

Registers one hotkey: a chord such as 'Mod+S', a sequence such as ['G', 'G'], or an app hotkey from defineAppHotkeys. The callback and options are refreshed after every commit.

Type Parameters#

T#

T extends RegisterableHotkey

Parameters#

hotkey#

T

callback#

HotkeyCallback<HotkeyCallbackContextFor<T>>

options?#

AdapterOptionsFor<T, UseHotkeyTarget>

Returns#

void