HotkeyConflictOptions | TanStack Hotkeys Docs

Properties

optional events?: readonly KeyboardEvent[];

optional events?: readonly KeyboardEvent[];

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

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

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

Intended event type. Default: keydown.

optional exclude?: (registration) => boolean;

optional exclude?: (registration) => boolean;

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

boolean

optional excludeIds?: readonly string[];

optional excludeIds?: readonly string[];

IDs of registrations being edited.

optional includeDisabled?: boolean;

optional includeDisabled?: boolean;

Include disabled registrations. Default: false.

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

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

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

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

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

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

optional target?: HTMLElement | Document | Window;

optional target?: HTMLElement | Document | Window;

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