TanStack

FormatForDisplayControllerOptions

Defined in: controllers/format-for-display.ts:14

Options for FormatForDisplayController.

Properties

keyboardLayout?

ts
optional keyboardLayout?: boolean;

Defined in: controllers/format-for-display.ts:26

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


platform?

ts
optional platform?: HotkeyPlatform;

Defined in: controllers/format-for-display.ts:19

The user's platform, for every label from format. Detected when unset. On a server, set it from the request with detectPlatform(userAgent).