HotkeysProviderOptions

Defined in: hotkeys-provider.ts:32

Properties#

hotkey?#

optional hotkey?: InjectHotkeyCommonOptions;

Defined in: hotkeys-provider.ts:51

Defaults for every hotkey registered by injectHotkey and injectHotkeys. requireReset applies to chords and timeout applies to sequences.

hotkeyRecorder?#

optional hotkeyRecorder?: Partial<Omit<HotkeyChordRecorderOptions & HotkeySequenceRecorderOptions, "maxSteps" | "validate" | "onRecord">>;

Defined in: hotkeys-provider.ts:53

Defaults for every injectHotkeyRecorder.

keyboardLayout?#

optional keyboardLayout?: boolean;

Defined in: hotkeys-provider.ts:46

Whether labels from injectFormatForDisplay follow the user's keyboard layout, so [KeyQ] reads A on a French AZERTY keyboard. The layout loads from the browser after the first label renders. Only Chromium browsers report one. Set false to never ask the browser for it. Default: true.

platform?#

optional platform?: HotkeyPlatform;

Defined in: hotkeys-provider.ts:38

The user's platform, for labels from injectFormatForDisplay, hotkeys, recorders, and app hotkey checks such as conflicts. Detected when unset. On a server, set it from the request with detectPlatform(userAgent).