Kbd

A key or a shortcut, shown as ⌘ on a Mac and Ctrl everywhere else.

Category
Data & feedback
Access
Free with an account
Source
140 lines · one file
States
4 drawn

The decision inside it

mod means this machine's command key

Hard-coding ⌘ tells every Windows reader the wrong key. The platform is read after the first render, so the server and the client agree and nothing logs a hydration warning.

When to use it

Use Kbd to show a key or a shortcut in a menu, tooltip or sentence. Write mod for the command key: it shows ⌘ on a Mac and Ctrl elsewhere.

Installation

How you get it

Paste this into Claude Code, Cursor, Codex or any coding agent. It installs the file and uses it as it is, instead of writing a new one.

Use Liro's Kbd for this.
Install it: npx shadcn@latest add @liro/kbd
(the @liro registry is set up in components.json, with LIRO_KEY in .env.local)
Import it from @/components/ui/kbd.
Do not rewrite or restyle it. Pass my data through its props
and keep its built-in states.

For the full brief with every prop and the mistakes assistants usually make, use Copy prompt above. Free components install through the @liro registry with your CLI token: see the Namespaced tab.

Usage

components/shortcut-hint.tsx
import { Kbd } from "@/components/ui/kbd";

export function ShortcutHint() {
  return (
    <p>
      Press <Kbd keys="mod+k" /> to search.
    </p>
  );
}

API reference

“Copy prompt” above puts a full brief on your clipboard, install command, dependencies, props, and the mistakes an assistant usually makes with this component.

Props

Read from the component’s own TypeScript interface when the site is built, so this table cannot drift from the file you install.

TypeNotes
keysstring | string[] YesThe shortcut: "mod+k", "shift+enter", or the keys as a list, ["⌘", "K"].
platformAwareboolean NoDraw `mod` as ⌘ on a Mac and Ctrl elsewhere (and alt, shift, ctrl the same way). Default true.
size"sm" | "md" Nosm for menus and tooltips, md for prose and settings. Default md.
variant"default" | "outline" | "ghost" Nodefault is a keycap, outline a hairline only, ghost a soft fill for dark tooltips.
separatorReact.ReactNode NoDrawn between keys. Default none: keycaps side by side read as a chord. Pass "+" or "then".

Dependencies

npm packages

clsxtailwind-merge

Liro foundations, installed alongside it

liro-theme

States

All of them are drawn by the component. None is left for you to design.

  • Keycap
  • Outline
  • Ghost
  • Sequence

Accessibility

  • Keyboard reachable throughout, in visual order
  • Focus trapped in overlays, Escape closes them
  • Focus returns to whatever opened it
  • Live regions announce what changed, not that something did
  • Honours prefers-reduced-motion

Responsive behavior

  • Sizes to its container, not the viewport
  • Usable from 320px up
  • Pointer-based interaction, so trackpad and touch both work
  • No hover-only affordances

Used in a screenAll screens

ScreenPro

Code Editor

An editor with an agent beside it: files, tabs and code, and a chat whose edits you accept one change at a time.