HotkeysProviderOptions

Properties

hotkey?

optional hotkey?: UseHotkeyCommonOptions;

Defined in: HotkeysProvider.tsx:49

Defaults for every hotkey registered by useHotkey and useHotkeys. requireReset applies to chords and timeout applies to sequences.

hotkeyRecorder?

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

Defined in: HotkeysProvider.tsx:51

Defaults for every useHotkeyRecorder.

keyboardLayout?

optional keyboardLayout?: boolean;

Defined in: HotkeysProvider.tsx:44

Whether labels from useFormatForDisplay 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:36

The user's platform, for labels from useFormatForDisplay, hotkeys, recorders, and app hotkey checks such as conflicts. Defaults to detection. When server rendering, set it from the request with detectPlatform(userAgent).