HotkeysProvider

function HotkeysProvider(__namedParameters): ElementDescriptor<{
  children: unknown;
  value: {
     appHotkeysStore:   | AppHotkeysStore<Readonly<Record<string, AppHotkey<string, HotkeyChord | HotkeySequence | null>>>>
        | null;
     defaultOptions: DefaultHotkeysOptions;
     enabled: boolean;
  };
}>;

Defined in: HotkeysProvider.ts:86

Sets defaults, app hotkeys, and custom hotkeys for descendant components.

Nest providers to create hotkey scopes. A nested provider inherits app hotkeys and merges default options. With scope, its hotkeys fire only while it is mounted and enabled; with exclusive, only its hotkeys fire.

Parameters#

__namedParameters#

HotkeysProviderProps

Returns#

ElementDescriptor<{ children: unknown; value: { appHotkeysStore: | AppHotkeysStore<Readonly<Record<string, AppHotkey<string, HotkeyChord | HotkeySequence | null>>>> | null; defaultOptions: DefaultHotkeysOptions; enabled: boolean; }; }>