# AppHotkeysProviderProps

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

Defined in: [AppHotkeysProvider.tsx:10](https://github.com/TanStack/hotkeys/blob/main/packages/react-hotkeys/src/AppHotkeysProvider.tsx#L10)

## Extends

- [`HotkeysProviderProps`](HotkeysProviderProps.md)\<`T`\>

## Type Parameters

### T

`T` *extends* `AppHotkeys` = `AppHotkeys`

## Properties

### appHotkeys

```ts
appHotkeys: T;
```

Defined in: [AppHotkeysProvider.tsx:13](https://github.com/TanStack/hotkeys/blob/main/packages/react-hotkeys/src/AppHotkeysProvider.tsx#L13)

Every app hotkey, from `defineAppHotkeys`. Listed by `useAppHotkeyList`
whether or not their components have mounted. It can start as `undefined`
and arrive later, such as from a lazy import.

#### Overrides

[`HotkeysProviderProps`](HotkeysProviderProps.md).[`appHotkeys`](HotkeysProviderProps.md#apphotkeys)

***

### children

```ts
children: ReactNode;
```

Defined in: [HotkeysProvider.tsx:63](https://github.com/TanStack/hotkeys/blob/main/packages/react-hotkeys/src/HotkeysProvider.tsx#L63)

#### Inherited from

[`HotkeysProviderProps`](HotkeysProviderProps.md).[`children`](HotkeysProviderProps.md#children)

***

### customHotkeys?

```ts
optional customHotkeys?: CustomHotkeys<T> | null;
```

Defined in: [HotkeysProvider.tsx:76](https://github.com/TanStack/hotkeys/blob/main/packages/react-hotkeys/src/HotkeysProvider.tsx#L76)

The user's saved custom hotkeys. When the value changes, such as after
saved data loads or the user signs in, it replaces the current custom
hotkeys. `undefined` leaves them unchanged; `null` clears them. Unknown
ids and invalid entries are ignored.

#### Inherited from

[`HotkeysProviderProps`](HotkeysProviderProps.md).[`customHotkeys`](HotkeysProviderProps.md#customhotkeys)

***

### defaultOptions?

```ts
optional defaultOptions?: HotkeysProviderOptions;
```

Defined in: [HotkeysProvider.tsx:80](https://github.com/TanStack/hotkeys/blob/main/packages/react-hotkeys/src/HotkeysProvider.tsx#L80)

Merged with the parent provider's defaults.

#### Inherited from

[`HotkeysProviderProps`](HotkeysProviderProps.md).[`defaultOptions`](HotkeysProviderProps.md#defaultoptions)

***

### onCustomHotkeysChange?

```ts
optional onCustomHotkeysChange?: (customHotkeys) => void;
```

Defined in: [HotkeysProvider.tsx:78](https://github.com/TanStack/hotkeys/blob/main/packages/react-hotkeys/src/HotkeysProvider.tsx#L78)

Called with the custom hotkeys after every change, ready to save.

#### Parameters

##### customHotkeys

`CustomHotkeys`\<`T`\>

#### Returns

`void`

#### Inherited from

[`HotkeysProviderProps`](HotkeysProviderProps.md).[`onCustomHotkeysChange`](HotkeysProviderProps.md#oncustomhotkeyschange)
