Skip to content
MIZU.

Kbd

Keyboard hints set apart from the surrounding sentence.

View .md

Live — this one is real

Press ⌘ + K to open your command palette.

Usage

tsx
import { Kbd } from "mizu-ui";

export function Example() {
  return (
    <p>
      Press <Kbd>⌘</Kbd> + <Kbd>K</Kbd> to open your command palette.
    </p>
  );
}

Source & setup

Add this component to your project with the shadcn CLI. The command copies its source into your configured UI directory, with base.css, Mizu’s tokens, and the stylesheets that hold its rules. Each rule lives in one stylesheet, so components you add together never repeat CSS. In a project without a components.json, run npx shadcn@latest init 0xuser64bit/mizu/preset first: plain init installs shadcn’s theme into your global CSS. Then load the fonts.

sh
npx shadcn@latest add 0xuser64bit/mizu/kbd

Every component imports from its own path, its name in kebab case. Its source, content/Typography.tsx, also holds CodeBlock, Quote, Prose, LinkCard and FileCard. Each has its own command and path; adding one after this copies only its small entry file. To paste the example, replace its mizu-ui import with:

tsx
import { Kbd } from "@/components/ui/mizu/kbd";

For npm imports, import mizu-ui/styles.css once. Fonts are optional via mizu-ui/fonts.css. Override --mizu-* tokens or use className for local styling. Uses native React and CSS; install the package peers for root imports. A Server Component: it renders on the server, with no client JavaScript of its own.

Inspect content/Typography.tsx

Source is included in the npm package under src/content/Typography.tsx.

Open full source ↗

Props

PropTypeDefaultDescription
childrenReactNode—Key name or chord.
...propsHTMLAttributes—Native kbd attributes.

Accessibility

Native kbd semantics. This displays a hint; keyboard handlers belong to the associated feature.

Motion

Static typographic cue.

Works alongside