HotkeysProviderProps

Defined in: HotkeysProvider.tsx:52

Extends#

• HotkeysProviderScopeProps

Properties#

appHotkeys?#

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

Defined in: HotkeysProvider.tsx:58

Every app hotkey, from defineAppHotkeys. Read when the provider is created; listed by createAppHotkeyList whether or not they are registered.

children#

children: Element;

Defined in: HotkeysProvider.tsx:53

customHotkeys?#

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

Defined in: HotkeysProvider.tsx:65

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?: HotkeysProviderOptions;

Defined in: HotkeysProvider.tsx:69

Merged with the parent provider's defaults.

onCustomHotkeysChange?#

optional onCustomHotkeysChange?: (customHotkeys) => void;

Defined in: HotkeysProvider.tsx:67

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

Parameters#

customHotkeys#

CustomHotkeys

Returns#

void