# CustomHotkeyActions

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

Defined in: [app-hotkeys.ts:401](https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/app-hotkeys.ts#L401)

Actions that change the user's custom hotkeys, as adapters return them.

## Properties

### findConflicts

```ts
findConflicts: (id, hotkey, recordedWith?) => AppHotkey<string, 
  | HotkeyChord
  | HotkeySequence
  | null>[];
```

Defined in: [app-hotkeys.ts:421](https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/app-hotkeys.ts#L421)

Other app hotkeys that would collide if `id` used `hotkey`. Pass the
recorder's `context` for a recorded hotkey: it has the key press, which
also finds a hotkey written differently that the same press fires.

#### Parameters

##### id

`string`

##### hotkey

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

##### recordedWith?

[`RecordedKeyPresses`](RecordedKeyPresses.md)

#### Returns

[`AppHotkey`](AppHotkey.md)\<`string`, 
  \| [`HotkeyChord`](../type-aliases/HotkeyChord.md)
  \| [`HotkeySequence`](../type-aliases/HotkeySequence.md)
  \| `null`\>[]

***

### resetCustomHotkey

```ts
resetCustomHotkey: (id) => void;
```

Defined in: [app-hotkeys.ts:413](https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/app-hotkeys.ts#L413)

Restores the default hotkey for an app hotkey.

#### Parameters

##### id

`string`

#### Returns

`void`

***

### resetCustomHotkeys

```ts
resetCustomHotkeys: () => void;
```

Defined in: [app-hotkeys.ts:415](https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/app-hotkeys.ts#L415)

Restores every default hotkey.

#### Returns

`void`

***

### setCustomHotkey

```ts
setCustomHotkey: (id, hotkey, recordedWith?) => AppHotkey<string, 
  | HotkeyChord
  | HotkeySequence
  | null>[];
```

Defined in: [app-hotkeys.ts:407](https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/app-hotkeys.ts#L407)

Sets the user's hotkey for an app hotkey. `null` unbinds it.
Returns conflicting app hotkeys; when any exist, nothing changes. Pass
the recorder's `context` for a recorded hotkey, as for `findConflicts`.

#### Parameters

##### id

`string`

##### hotkey

[`Hotkey`](../type-aliases/Hotkey.md) \| `null`

##### recordedWith?

[`RecordedKeyPresses`](RecordedKeyPresses.md)

#### Returns

[`AppHotkey`](AppHotkey.md)\<`string`, 
  \| [`HotkeyChord`](../type-aliases/HotkeyChord.md)
  \| [`HotkeySequence`](../type-aliases/HotkeySequence.md)
  \| `null`\>[]