# 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/octane-hotkeys/src/formatForDisplay.ts#L12)

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

## Deprecated

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