HotkeyConflictOptions

Defined in: conflicts.ts:18

Properties#

events?#

optional events?: readonly KeyboardEvent[];

Defined in: conflicts.ts:34

Source events allow detecting physical/logical overlap on the recorded layout.

eventType?#

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

Defined in: conflicts.ts:24

Intended event type. Default: keydown.

exclude?#

optional exclude?: (registration) => boolean;

Defined in: conflicts.ts:30

Additional app-specific exclusions, such as all instances of one action.

Parameters#

registration#

HotkeyRegistrationView

Returns#

boolean

excludeIds?#

optional excludeIds?: readonly string[];

Defined in: conflicts.ts:28

IDs of registrations being edited.

includeDisabled?#

optional includeDisabled?: boolean;

Defined in: conflicts.ts:26

Include disabled registrations. Default: false.

platform?#

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

Defined in: conflicts.ts:32

Platform used to resolve Mod in the candidate. Registrations retain their own platform.

scope?#

optional scope?: "all" | "overlapping";

Defined in: conflicts.ts:22

Check all targets instead of overlapping targets. Default: overlapping.

target?#

optional target?: HTMLElement | Document | Window;

Defined in: conflicts.ts:20

Intended registration target. Defaults to document; disjoint targets are excluded.