HotkeyChordOptions

Options for a single chord such as 'Mod+S'.

Extends

HotkeyOptions

Properties

appHotkeyId?

optional appHotkeyId?: string;

Defined in: hotkey-manager.ts:111

Id of the app hotkey this registration implements. Adapters set this when registering an app hotkey from defineAppHotkeys.

Inherited from

HotkeyOptions.appHotkeyId

capture?

optional capture?: boolean;

Defined in: hotkey-manager.ts:62

Listen during capture, before descendant listeners. Defaults to false (bubble). With stopPropagation: true, a match on an ancestor prevents the event from reaching descendant widgets. Other listeners on the same target still run. Applies to both keydown and keyup, for chords and sequences. Changing this option preserves held-key reset state and sequence progress.

Inherited from

HotkeyOptions.capture

conflictBehavior?

optional conflictBehavior?: ConflictBehavior;

Defined in: hotkey-manager.ts:64

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:70

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?: "keydown" | "keyup";

Defined in: hotkey-manager.ts:72

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

Inherited from

HotkeyOptions.eventType

ignoreInputs?

optional ignoreInputs?: boolean | "auto";

Defined in: hotkey-manager.ts:83

Skip keys that a focused control inside the target uses itself: typing in text inputs, textarea, select, and contenteditable; Enter/Space on buttons and summary elements; Enter on links; and navigation keys in ARIA widgets such as menus, listboxes, tabs, and grids. A hotkey targeted at the control itself still receives them. Defaults to 'auto', which chooses from the hotkey (the first step of a sequence): true for single keys and Shift/Alt combos; false for Ctrl/Meta shortcuts and Escape. Set false to handle keys even in these controls.

Inherited from

HotkeyOptions.ignoreInputs

meta?

optional meta?: HotkeyMeta;

Defined in: hotkey-manager.ts:99

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

Inherited from

HotkeyOptions.meta

platform?

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

Defined in: hotkey-manager.ts:85

The target platform for resolving 'Mod'

Inherited from

HotkeyOptions.platform

preventDefault?

optional preventDefault?: boolean;

Defined in: hotkey-manager.ts:90

Prevent the default browser action when the hotkey matches. For a sequence, every step that advances it does. Defaults to true

Inherited from

HotkeyOptions.preventDefault

requireReset?

optional requireReset?: boolean;

Defined in: hotkey-manager.ts:117

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

scope?

optional scope?: string;

Defined in: hotkey-manager.ts:109

Scope this hotkey belongs to. Defaults to 'global', which is always active. Other scopes are active while activated with HotkeyManager.activateScope, which framework providers do while mounted. While an exclusive scope is active, only its hotkeys, those of scopes nested in it, and those of scopes it allows fire. When active scopes share a hotkey on the same target, the most recently activated scope handles it.