# formatForDisplay

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

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

Defined in: [formatForDisplay.ts:12](https://github.com/TanStack/hotkeys/blob/main/packages/alpine-hotkeys/src/formatForDisplay.ts#L12)

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

## Deprecated

Use `createFormatForDisplay()` on a `createHotkeysScope` owner in
components. It returns this function with the scope's platform and the user's
keyboard layout filled in. Outside a component, keep calling this function
and pass `platform` yourself.
