TanStack
Hotkey Recorder API Reference

RecorderOptions

Defined in: recorder-options.ts:15

Extended by

Properties

detectConflicts?

ts
optional detectConflicts: boolean | HotkeyConflictOptions;

Defined in: recorder-options.ts:21

Opt in to live-registry conflicts, including sequence prefixes. Default: false.


onReject()?

ts
optional onReject: (rejection) => void;

Defined in: recorder-options.ts:23

Rejected candidates leave recording active.

Parameters

rejection

RecorderRejection

Returns

void


platform?

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

Defined in: recorder-options.ts:19

Platform used for Mod and AltGraph handling. Defaults to platform detection.


recordBy?

ts
optional recordBy: RecorderKeyMode;

Defined in: recorder-options.ts:17

Physical code recording is the default. Choose key to record logical characters.