Interface: HotkeyOptions

Defined in: hotkey-manager.ts:28

Options for registering a hotkey.

Properties

conflictBehavior?

optional conflictBehavior: ConflictBehavior;

optional conflictBehavior: ConflictBehavior;

Defined in: hotkey-manager.ts:30

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

enabled?

optional enabled: boolean;

optional enabled: boolean;

Defined in: hotkey-manager.ts:36

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.

eventType?

optional eventType: "keydown" | "keyup";

optional eventType: "keydown" | "keyup";

Defined in: hotkey-manager.ts:38

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

ignoreInputs?

optional ignoreInputs: boolean;

optional ignoreInputs: boolean;

Defined in: hotkey-manager.ts:40

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

meta?

optional meta: HotkeyMeta;

optional meta: HotkeyMeta;

Defined in: hotkey-manager.ts:52

Optional metadata (name, description, custom fields via declaration merging)

platform?

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

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

Defined in: hotkey-manager.ts:42

The target platform for resolving 'Mod'

preventDefault?

optional preventDefault: boolean;

optional preventDefault: boolean;

Defined in: hotkey-manager.ts:44

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

requireReset?

optional requireReset: boolean;

optional requireReset: boolean;

Defined in: hotkey-manager.ts:46

If true, only trigger once until all keys are released. Default: false

stopPropagation?

optional stopPropagation: boolean;

optional stopPropagation: boolean;

Defined in: hotkey-manager.ts:48

Stop event propagation when the hotkey matches. Defaults to true

target?

optional target: HTMLElement | Document | Window | null;

optional target: HTMLElement | Document | Window | null;

Defined in: hotkey-manager.ts:50

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