# formatForDisplay

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

```ts
const formatForDisplay: typeof coreFormatForDisplay = coreFormatForDisplay;
```

Defined in: [format-for-display.ts:12](https://github.com/TanStack/hotkeys/blob/main/packages/lit-hotkeys/src/format-for-display.ts#L12)

Formats a hotkey as a label, without a controller's platform or the user's
keyboard layout.

## Deprecated

Use `FormatForDisplayController` in elements. Its `format` is
this function with the controller's platform and the user's keyboard layout
filled in. Outside an element, keep calling this function and pass `platform`
yourself.
