HotkeysProviderProps

Defined in: HotkeysProvider.tsx:61

Extends#

• HotkeysProviderScopeProps

Type Parameters#

T#

T extends AppHotkeys = AppHotkeys

Properties#

appHotkeys?#

optional appHotkeys?: T;

Defined in: HotkeysProvider.tsx:70

Every app hotkey, from defineAppHotkeys. Listed by useAppHotkeyList whether or not their components have mounted. It can start as undefined and arrive later, such as from a lazy import.

children#

children: ReactNode;

Defined in: HotkeysProvider.tsx:64

customHotkeys?#

optional customHotkeys?: CustomHotkeys<T> | null;

Defined in: HotkeysProvider.tsx:77

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. Unknown ids and invalid entries are ignored.

defaultOptions?#

optional defaultOptions?: HotkeysProviderOptions;

Defined in: HotkeysProvider.tsx:81

Merged with the parent provider's defaults.

onCustomHotkeysChange?#

optional onCustomHotkeysChange?: (customHotkeys) => void;

Defined in: HotkeysProvider.tsx:79

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

Parameters#

customHotkeys#

CustomHotkeys<T>

Returns#

void