KeyboardShortcut
Time & Keyboard

KeyboardShortcut

Renders a keyboard shortcut as key caps (e.g. ⌘K). Use mod for the primary modifier rather than hardcoding ⌘ or Ctrl.

Props

KeyboardShortcutProps props
PropTypeDefaultDescription
keysstring—Shortcut string with + separators, e.g. "mod+k", "shift+/", "ctrl+alt+delete".
platform"mac" | "win"—Force a platform instead of sniffing. mod renders ⌘ on mac, Ctrl on win.
size"sm" | "md""md"Key cap size.
joinedboolean—Renders one merged cap (⌘K) instead of separate keys.
subtleboolean—Dim styling for shortcuts inside an already-highlighted row.

Examples

mod+K

CtrlK
mod+K shortcut

mod+shift+/

CtrlShift/
mod+shift+/

Joined

Ctrl+K
Joined shortcut

Size sm

CtrlEnter
Small size

Subtle

CtrlK
Subtle variant

Explicit platform

Explicit platform
ImportTSX
import { KeyboardShortcut } from "@solarius/onset";
import type { KeyboardShortcutProps } from "@solarius/onset";