AppHotkeysStoreOptions

Defined in: app-hotkeys.ts:429

Options for AppHotkeysStore.

Type Parameters#

T#

T extends AppHotkeys = AppHotkeys

Properties#

customHotkeys?#

optional customHotkeys?: CustomHotkeys<T> | null;

Defined in: app-hotkeys.ts:437

The user's saved custom hotkeys. Unknown ids and invalid entries are ignored. Passing a different value to setOptions later, such as data that finished loading or another user's data, replaces the current custom hotkeys. undefined leaves them unchanged; a change to null clears them.

onCustomHotkeysChange?#

optional onCustomHotkeysChange?: (customHotkeys) => void;

Defined in: app-hotkeys.ts:439

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

Parameters#

customHotkeys#

CustomHotkeys<T>

Returns#

void

platform?#

optional platform?: HotkeyPlatform;

Defined in: app-hotkeys.ts:441

Platform used to compare hotkeys. Defaults to detection.