Skip to main content

HotkeyConflictOptions

还没翻译译自英文(tanstack.com)本页 32 段都还没译

Defined in: conflicts.ts:15

Properties

events?

optional events?: readonly KeyboardEvent[];

Defined in: conflicts.ts:33

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


eventType?

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

Defined in: conflicts.ts:21

Intended event type. Default: keydown.


exclude?

optional exclude?: (registration) => boolean;

Defined in: conflicts.ts:27

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

Parameters

registration

| HotkeyRegistrationView | SequenceRegistrationView

Returns

boolean


excludeIds?

optional excludeIds?: readonly string[];

Defined in: conflicts.ts:25

IDs of registrations being edited.


includeDisabled?

optional includeDisabled?: boolean;

Defined in: conflicts.ts:23

Include disabled registrations. Default: false.


platform?

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

Defined in: conflicts.ts:31

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


scope?

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

Defined in: conflicts.ts:19

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


target?

optional target?: Document | Window | HTMLElement;

Defined in: conflicts.ts:17

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