ProvideHotkeysOptions

Defined in: hotkeys-provider.ts:54

Options for provideHotkeys.

Properties#

appHotkeys?#

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

Defined in: hotkeys-provider.ts:76

Every app hotkey, from defineAppHotkeys. Listed by injectAppHotkeyList whether or not they are registered.

customHotkeys?#

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

Defined in: hotkeys-provider.ts:83

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

Defined in: hotkeys-provider.ts:60

Merged with the parent provider's defaults. A getter runs in the provider's injection context, so it can inject(REQUEST) to set platform from the request during server rendering.

enabled?#

optional enabled?: MaybeGetter<boolean | undefined>;

Defined in: hotkeys-provider.ts:71

See HotkeysProviderScopeProps['enabled'].

exclusive?#

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

Defined in: hotkeys-provider.ts:69

See HotkeysProviderScopeProps['exclusive'].

onCustomHotkeysChange?#

optional onCustomHotkeysChange?: (customHotkeys) => void;

Defined in: hotkeys-provider.ts:85

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

Parameters#

customHotkeys#

CustomHotkeys

Returns#

void

scope?#

optional scope?: MaybeGetter<string | undefined>;

Defined in: hotkeys-provider.ts:67

See HotkeysProviderScopeProps['scope']. Getters, here and for exclusive and enabled, run in the provider's injection context, so they can inject() the component that provides them and read its signals.