# HotkeyChordRecorderOptions

<!-- DO NOT EDIT: this page is autogenerated from the type comments -->

Defined in: [hotkey-recorder.ts:146](https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/hotkey-recorder.ts#L146)

Options for recording a single chord. This is the default (`maxSteps: 1`).

## Extends

- `HotkeyRecorderBaseOptions`

## Properties

### detectConflicts?

```ts
optional detectConflicts?: boolean | HotkeyConflictOptions;
```

Defined in: [hotkey-recorder.ts:76](https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/hotkey-recorder.ts#L76)

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

#### Inherited from

```ts
HotkeyRecorderBaseOptions.detectConflicts
```

***

### ignoreInputs?

```ts
optional ignoreInputs?: boolean;
```

Defined in: [hotkey-recorder.ts:135](https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/hotkey-recorder.ts#L135)

Whether to ignore keyboard events from input-like elements (text inputs,
textarea, select, contenteditable) while recording. When true, typing in
inputs passes through normally (Escape still cancels). Defaults to true.

#### Inherited from

```ts
HotkeyRecorderBaseOptions.ignoreInputs
```

***

### maxSteps?

```ts
optional maxSteps?: 1;
```

Defined in: [hotkey-recorder.ts:148](https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/hotkey-recorder.ts#L148)

Maximum number of chords to record. Default: 1

***

### onCancel?

```ts
optional onCancel?: () => void;
```

Defined in: [hotkey-recorder.ts:124](https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/hotkey-recorder.ts#L124)

Optional callback when recording is cancelled: Escape, or Tab without `recordTab`

#### Returns

`void`

#### Inherited from

```ts
HotkeyRecorderBaseOptions.onCancel
```

***

### onClear?

```ts
optional onClear?: () => void;
```

Defined in: [hotkey-recorder.ts:129](https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/hotkey-recorder.ts#L129)

Optional callback when the recording is cleared: Backspace/Delete with no
modifiers and no recorded steps

#### Returns

`void`

#### Inherited from

```ts
HotkeyRecorderBaseOptions.onClear
```

***

### onRecord

```ts
onRecord: (hotkey, context) => void;
```

Defined in: [hotkey-recorder.ts:158](https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/hotkey-recorder.ts#L158)

Callback when a chord is successfully recorded. `context` is the one
`validate` received, with the key press that recorded the chord.

#### Parameters

##### hotkey

[`HotkeyChord`](../type-aliases/HotkeyChord.md)

##### context

[`HotkeyChordRecorderValidationContext`](HotkeyChordRecorderValidationContext.md)

#### Returns

`void`

***

### onReject?

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

Defined in: [hotkey-recorder.ts:78](https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/hotkey-recorder.ts#L78)

Rejected candidates leave recording active.

#### Parameters

##### rejection

[`RecorderRejection`](RecorderRejection.md)

#### Returns

`void`

#### Inherited from

```ts
HotkeyRecorderBaseOptions.onReject
```

***

### platform?

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

Defined in: [hotkey-recorder.ts:74](https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/hotkey-recorder.ts#L74)

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

#### Inherited from

```ts
HotkeyRecorderBaseOptions.platform
```

***

### recordBy?

```ts
optional recordBy?: RecorderKeyMode;
```

Defined in: [hotkey-recorder.ts:72](https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/hotkey-recorder.ts#L72)

How the pressed key is written. Default: `'auto'`.

#### Inherited from

```ts
HotkeyRecorderBaseOptions.recordBy
```

***

### recordTab?

```ts
optional recordTab?: boolean;
```

Defined in: [hotkey-recorder.ts:142](https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/hotkey-recorder.ts#L142)

Whether to record Tab and Shift+Tab. By default they cancel recording and
move focus, so keyboard users can leave the recorder. Tab with Control,
Alt, or Meta isn't affected. When true, tell users that Escape cancels.
Default: false

#### Inherited from

```ts
HotkeyRecorderBaseOptions.recordTab
```

***

### validate?

```ts
optional validate?: (hotkey, context) => string | boolean;
```

Defined in: [hotkey-recorder.ts:150](https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/hotkey-recorder.ts#L150)

Return true to accept, or false or a message to reject while staying in recording mode. The message is passed to `onReject`.

#### Parameters

##### hotkey

[`HotkeyChord`](../type-aliases/HotkeyChord.md)

##### context

[`HotkeyChordRecorderValidationContext`](HotkeyChordRecorderValidationContext.md)

#### Returns

`string` \| `boolean`