DefaultHotkeysOptions

Defined in: types.ts:249

Shared defaults; call-specific options take precedence.

Properties#

hotkey?#

optional hotkey?: AlpineHotkeyCommonOptions;

Defined in: types.ts:265

Defaults for every hotkey. requireReset applies to chords and timeout to sequences.

hotkeyRecorder?#

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

Defined in: types.ts:267

Defaults for every recorder.

keyboardLayout?#

optional keyboardLayout?: boolean;

Defined in: types.ts:263

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 createFormatForDisplay or createKeyboardLayout runs. Only Chromium browsers report one. Set false to never ask the browser for it. Default: true.

platform?#

optional platform?: HotkeyPlatform;

Defined in: types.ts:255

The user's platform, for labels from createFormatForDisplay, hotkeys, and recorders. hotkey.platform and hotkeyRecorder.platform win. Detected when unset.