# HotkeysProviderOptions

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

Defined in: [hotkeys-provider.ts:32](https://github.com/TanStack/hotkeys/blob/main/packages/angular-hotkeys/src/hotkeys-provider.ts#L32)

## Properties

### hotkey?

```ts
optional hotkey?: InjectHotkeyCommonOptions;
```

Defined in: [hotkeys-provider.ts:51](https://github.com/TanStack/hotkeys/blob/main/packages/angular-hotkeys/src/hotkeys-provider.ts#L51)

Defaults for every hotkey registered by `injectHotkey` and `injectHotkeys`.
`requireReset` applies to chords and `timeout` applies to sequences.

***

### hotkeyRecorder?

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

Defined in: [hotkeys-provider.ts:53](https://github.com/TanStack/hotkeys/blob/main/packages/angular-hotkeys/src/hotkeys-provider.ts#L53)

Defaults for every `injectHotkeyRecorder`.

***

### keyboardLayout?

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

Defined in: [hotkeys-provider.ts:46](https://github.com/TanStack/hotkeys/blob/main/packages/angular-hotkeys/src/hotkeys-provider.ts#L46)

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

***

### platform?

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

Defined in: [hotkeys-provider.ts:38](https://github.com/TanStack/hotkeys/blob/main/packages/angular-hotkeys/src/hotkeys-provider.ts#L38)

The user's platform, for labels from `injectFormatForDisplay`, hotkeys,
recorders, and app hotkey checks such as conflicts. Detected when unset. On
a server, set it from the request with `detectPlatform(userAgent)`.