ProvideHotkeysContextOptions

Defined in: HotkeysProviderContext.ts:66

Options for provideHotkeysContext.

Properties#

appHotkeys?#

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

Defined in: HotkeysProviderContext.ts:79

Every app hotkey, from defineAppHotkeys. Read when the context is provided; later changes update the declarations.

customHotkeys?#

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

Defined in: HotkeysProviderContext.ts:86

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?: MaybeRefOrGetter<HotkeysProviderOptions | undefined>;

Defined in: HotkeysProviderContext.ts:68

Merged with the parent context's defaults.

enabled?#

optional enabled?: MaybeRefOrGetter<boolean | undefined>;

Defined in: HotkeysProviderContext.ts:74

See HotkeysProviderScopeProps['enabled'].

exclusive?#

optional exclusive?: MaybeRefOrGetter<
  | boolean
  | {
}
| undefined>;

Defined in: HotkeysProviderContext.ts:72

See HotkeysProviderScopeProps['exclusive'].

onCustomHotkeysChange?#

optional onCustomHotkeysChange?: (customHotkeys) => void;

Defined in: HotkeysProviderContext.ts:88

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

Parameters#

customHotkeys#

CustomHotkeys

Returns#

void

scope?#

optional scope?: MaybeRefOrGetter<string | undefined>;

Defined in: HotkeysProviderContext.ts:70

See HotkeysProviderScopeProps['scope'].