# HotkeysProviderOptions

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

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

## Properties

### hotkey?

```ts
optional hotkey?: UseHotkeyCommonOptions;
```

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

Defaults for every hotkey registered by `useHotkey` and `useHotkeys`.
`requireReset` applies to chords and `timeout` applies to sequences.

***

### hotkeyRecorder?

```ts
optional hotkeyRecorder?: Partial<Omit<HotkeyChordRecorderOptions & HotkeySequenceRecorderOptions, "maxSteps" | "validate" | "onRecord">>;
```

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

Defaults for every `useHotkeyRecorder`.

***

### keyboardLayout?

```ts
optional keyboardLayout?: boolean;
```

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

Whether labels from `useFormatForDisplay` follow the user's keyboard
layout, so `[KeyQ]` reads `A` on a French AZERTY keyboard. The layout
loads from the browser when the first label mounts. Only Chromium
browsers report one. Set `false` to never ask the browser for it.
Default: `true`.

***

### platform?

```ts
optional platform?: HotkeyPlatform;
```

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

The user's platform, for labels from `useFormatForDisplay`, hotkeys,
recorders, and app hotkey checks such as conflicts. Defaults to detection.
When server rendering, set it from the request with
`detectPlatform(userAgent)`.