HotkeysProviderProps | TanStack Hotkeys Svelte Docs

Options for setHotkeysContext and props for HotkeysProvider.

Extends

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

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

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

children: Snippet;

children: Snippet;

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

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

Starting custom hotkeys, such as saved data. Read once; the context owns the state afterwards. Invalid entries are ignored with a warning.

optional defaultOptions?: HotkeysProviderOptions;

optional defaultOptions?: HotkeysProviderOptions;

Merged with the parent context's defaults.

optional onCustomHotkeysChange?: (customHotkeys) => void;

optional onCustomHotkeysChange?: (customHotkeys) => void;

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

CustomHotkeys

void