HotkeysContextOptions

Defined in: packages/svelte-hotkeys/src/HotkeysCtx.ts:36

Options for setHotkeysContext and props for HotkeysProvider.

Extends#

• HotkeysProviderScopeProps

Extended by#

• HotkeysProviderProps

Properties#

appHotkeys?#

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

Defined in: packages/svelte-hotkeys/src/HotkeysCtx.ts:43

Every app hotkey, from defineAppHotkeys. Read when the context is set; listed by getAppHotkeyList whether or not they are registered.

customHotkeys?#

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

Defined in: packages/svelte-hotkeys/src/HotkeysCtx.ts:50

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: packages/svelte-hotkeys/src/HotkeysCtx.ts:38

Merged with the parent context's defaults.

onCustomHotkeysChange?#

optional onCustomHotkeysChange?: (customHotkeys) => void;

Defined in: packages/svelte-hotkeys/src/HotkeysCtx.ts:52

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

Parameters#

customHotkeys#

CustomHotkeys

Returns#

void