HotkeysProviderOptions

Defined in: HotkeysProvider.tsx:28

Properties#

hotkey?#

optional hotkey?: CreateHotkeyCommonOptions;

Defined in: HotkeysProvider.tsx:47

Defaults for every hotkey registered by createHotkey and createHotkeys. requireReset applies to chords and timeout applies to sequences.

hotkeyRecorder?#

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

Defined in: HotkeysProvider.tsx:49

Defaults for every createHotkeyRecorder.

keyboardLayout?#

optional keyboardLayout?: boolean;

Defined in: HotkeysProvider.tsx:42

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

platform?#

optional platform?: HotkeyPlatform;

Defined in: HotkeysProvider.tsx:34

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