SequenceOptions | TanStack Hotkeys Русский

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

Extends

Omit<HotkeyOptions, "requireReset">

Properties

conflictBehavior?

optional conflictBehavior?: ConflictBehavior;

Defined in: hotkey-manager.ts:33

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

Inherited from

HotkeyOptions.conflictBehavior

enabled?

optional enabled?: boolean;

Defined in: hotkey-manager.ts:39

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.

Inherited from

HotkeyOptions.enabled

eventType?

optional eventType?: "keyup" | "keydown";

Defined in: hotkey-manager.ts:41

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

Inherited from

HotkeyOptions.eventType

ignoreInputs?

optional ignoreInputs?: boolean;

Defined in: hotkey-manager.ts:43

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

Inherited from

HotkeyOptions.ignoreInputs

meta?

optional meta?: HotkeyMeta;

Defined in: hotkey-manager.ts:55

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

Inherited from

HotkeyOptions.meta

platform?

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

Defined in: hotkey-manager.ts:45

The target platform for resolving 'Mod'

Inherited from

HotkeyOptions.platform

preventDefault?

optional preventDefault?: boolean;

Defined in: hotkey-manager.ts:47

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

Inherited from

HotkeyOptions.preventDefault

stopPropagation?

optional stopPropagation?: boolean;

Defined in: hotkey-manager.ts:51

Stop event propagation when the hotkey matches. Defaults to true

Inherited from

HotkeyOptions.stopPropagation

target?

optional target?: Document | Window | HTMLElement | null;

Defined in: hotkey-manager.ts:53

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

Inherited from

HotkeyOptions.target

timeout?

optional timeout?: number;

Defined in: sequence-manager.ts:33

Timeout between keys in milliseconds. Default: 1000