TanStack
Hotkey Recorder API Reference

RecorderOptions

Defined in: hotkey-recorder.ts:33

Properties

detectConflicts?

ts
optional detectConflicts?: boolean | HotkeyConflictOptions;

Defined in: hotkey-recorder.ts:39

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


onReject?

ts
optional onReject?: (rejection) => void;

Defined in: hotkey-recorder.ts:41

Rejected candidates leave recording active.

Parameters

rejection

RecorderRejection

Returns

void


platform?

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

Defined in: hotkey-recorder.ts:37

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


recordBy?

ts
optional recordBy?: RecorderKeyMode;

Defined in: hotkey-recorder.ts:35

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