Defined in: sequence-manager.ts:27

Options for hotkey sequence matching. Extends HotkeyOptions but excludes requireReset (not applicable to sequences).

• Omit<HotkeyOptions, "requireReset">

optional conflictBehavior: ConflictBehavior;

Defined in: hotkey-manager.ts:29

Behavior when this hotkey conflicts with an existing registration on the same target. Defaults to 'warn'

HotkeyOptions.conflictBehavior

optional enabled: boolean;

Defined in: hotkey-manager.ts:35

Soft-disable: when false, the callback does not run but the registration stays in HotkeyManager (and in devtools). Toggling this should update the existing handle via setOptions rather than unregistering. Defaults to true.

HotkeyOptions.enabled

optional eventType: "keydown" | "keyup";

Defined in: hotkey-manager.ts:37

The event type to listen for. Defaults to 'keydown'

HotkeyOptions.eventType

optional ignoreInputs: boolean;

Defined in: hotkey-manager.ts:39

Whether to ignore hotkeys when keyboard events originate from input-like elements (text inputs, textarea, select, contenteditable — button-type inputs like type=button/submit/reset are not ignored). Defaults based on hotkey: true for single keys and Shift/Alt combos; false for Ctrl/Meta shortcuts and Escape

HotkeyOptions.ignoreInputs

optional platform: "mac" | "windows" | "linux";

Defined in: hotkey-manager.ts:41

The target platform for resolving 'Mod'

HotkeyOptions.platform

optional preventDefault: boolean;

Defined in: hotkey-manager.ts:43

Prevent the default browser action when the hotkey matches. Defaults to true

HotkeyOptions.preventDefault

optional stopPropagation: boolean;

Defined in: hotkey-manager.ts:47

Stop event propagation when the hotkey matches. Defaults to true

HotkeyOptions.stopPropagation

optional target: HTMLElement | Document | Window | null;

Defined in: hotkey-manager.ts:49

The DOM element to attach the event listener to. Defaults to document.

HotkeyOptions.target

optional timeout: number;

Defined in: sequence-manager.ts:29

Timeout between keys in milliseconds. Default: 1000