HotkeysProviderProps

Defined in: HotkeysProvider.ts:53

Extends#

• HotkeysProviderScopeProps

Properties#

appHotkeys?#

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

Defined in: HotkeysProvider.ts:61

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:54

customHotkeys?#

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

Defined in: HotkeysProvider.ts:68

The user's saved custom hotkeys. When the value changes, such as after saved data loads or the user signs in, it replaces the current custom hotkeys. undefined leaves them unchanged; null clears them. Invalid entries are ignored with a warning.

defaultOptions?#

optional defaultOptions?: DefaultHotkeysOptions;

Defined in: HotkeysProvider.ts:56

Merged with the parent provider's defaults.

onCustomHotkeysChange?#

optional onCustomHotkeysChange?: (customHotkeys) => void;

Defined in: HotkeysProvider.ts:70

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

Parameters#

customHotkeys#

CustomHotkeys

Returns#

void