HotkeysProviderProps

Defined in: HotkeysProvider.ts:42

Properties#

appHotkeys?#

optional appHotkeys?: Readonly<Record<string, AppHotkey<string, HotkeyChord | HotkeySequence | null>>>;

Defined in: HotkeysProvider.ts:49

Every app hotkey, from defineAppHotkeys. Read when the provider first renders; listed by useAppHotkeyList whether or not they are registered.

children?#

optional children?: unknown;

Defined in: HotkeysProvider.ts:43

customHotkeys?#

optional customHotkeys?: 
  | CustomHotkeys<Readonly<Record<string, AppHotkey<string, HotkeyChord | HotkeySequence | null>>>>
  | null;

Defined in: HotkeysProvider.ts:54

Starting custom hotkeys, such as saved data. Read once; the provider owns the state afterwards. Invalid entries are ignored with a warning.

defaultOptions?#

optional defaultOptions?: DefaultHotkeysOptions;

Defined in: HotkeysProvider.ts:44

onCustomHotkeysChange?#

optional onCustomHotkeysChange?: (customHotkeys) => void;

Defined in: HotkeysProvider.ts:56

Called with the custom hotkeys after every change, ready to save.

Parameters#

customHotkeys#

CustomHotkeys

Returns#

void