Docs
Cloudflare
Railway
CodeRabbit
AG Grid
WorkOS
SerpAPI
Netlify
OpenRouter
Clerk
Sentry
Prisma
Unkey
Electric
Cloudflare
Railway
CodeRabbit
AG Grid
WorkOS
SerpAPI
Netlify
OpenRouter
Clerk
Sentry
Prisma
Unkey
Electric
API Reference
Hotkeys API Reference
Hotkey Sequence API Reference
Key hold & held keys API Reference
Hotkey Recorder API Reference
Hotkey Sequence Recorder API Reference
Normalization & format API Reference
Normalization & format API Reference

FormatDisplayOptions

Interface: FormatDisplayOptions

Defined in: hotkey.ts:367

Options for formatting hotkeys for display.

Properties

platform?

ts
optional platform: "mac" | "windows" | "linux";
optional platform: "mac" | "windows" | "linux";

Defined in: hotkey.ts:369

The target platform. Defaults to auto-detection.


separatorToken?

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

Defined in: hotkey.ts:373

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


useSymbols?

ts
optional useSymbols: boolean;
optional useSymbols: boolean;

Defined in: hotkey.ts:371

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