# FormatDisplayOptions

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

Defined in: [format.ts:273](https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/format.ts#L273)

Options for formatting hotkeys for display.

## Properties

### keyLabels?

```ts
optional keyLabels?: Readonly<Record<string, string>>;
```

Defined in: [format.ts:291](https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/format.ts#L291)

Final display overrides for logical keys or physical codes; take precedence over layoutMap. Never changes matching.

***

### layoutMap?

```ts
optional layoutMap?: object;
```

Defined in: [format.ts:289](https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/format.ts#L289)

An already-resolved code-to-key map, such as KeyboardLayoutMap or Map.
Used only for physical bindings. Mapped keys receive normal display formatting;
missing or empty entries use conventional fallback labels. The caller owns
loading and refreshing the map; this formatter never calls browser APIs.

#### get

```ts
get: (code) => string | undefined;
```

##### Parameters

###### code

`string`

##### Returns

`string` \| `undefined`

***

### parts?

```ts
optional parts?: boolean;
```

Defined in: [format.ts:282](https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/format.ts#L282)

Return individual key labels instead of a joined string. Default: false.

***

### platform?

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

Defined in: [format.ts:278](https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/format.ts#L278)

The target platform. Without it, `formatForDisplay` detects the platform
in the browser and uses `'linux'` on a server.

***

### separatorToken?

```ts
optional separatorToken?: string | null;
```

Defined in: [format.ts:293](https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/format.ts#L293)

Override the separator between display tokens. Defaults to platform-specific formatting when null/undefined.

***

### sequenceSeparator?

```ts
optional sequenceSeparator?: string;
```

Defined in: [format.ts:295](https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/format.ts#L295)

Separator between sequence steps. Default: a space.

***

### useSymbols?

```ts
optional useSymbols?: 
  | boolean
  | {
  keys?: boolean;
  modifiers?: boolean;
};
```

Defined in: [format.ts:280](https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/format.ts#L280)

Whether to use symbols for the display. Defaults to true.