AppHotkeysProviderProps

Defined in: AppHotkeysProvider.tsx:10

Extends#

• HotkeysProviderProps<T>

Type Parameters#

T#

T extends AppHotkeys = AppHotkeys

Properties#

appHotkeys#

appHotkeys: T;

Defined in: AppHotkeysProvider.tsx:13

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.

Overrides#

HotkeysProviderProps.appHotkeys

children#

children: ReactNode;

Defined in: HotkeysProvider.tsx:63

Inherited from#

HotkeysProviderProps.children

customHotkeys?#

optional customHotkeys?: CustomHotkeys<T> | null;

Defined in: HotkeysProvider.tsx:76

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.

Inherited from#

HotkeysProviderProps.customHotkeys

defaultOptions?#

optional defaultOptions?: HotkeysProviderOptions;

Defined in: HotkeysProvider.tsx:80

Merged with the parent provider's defaults.

Inherited from#

HotkeysProviderProps.defaultOptions

onCustomHotkeysChange?#

optional onCustomHotkeysChange?: (customHotkeys) => void;

Defined in: HotkeysProvider.tsx:78

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

Parameters#

customHotkeys#

CustomHotkeys<T>

Returns#

void

Inherited from#

HotkeysProviderProps.onCustomHotkeysChange