Foundations · stable · MIT

Kbd

Keyboard notation for shortcuts and key sequences.

Install editable source

Add Kbd

Base UI / canonicalnpx shadcn@latest add https://gummyui.dev/r/gummy-kbd.json

No package dependency beyond React. Shared Gummy material is resolved automatically.

Behavior contract

Semantics before surface

Semantics

Native kbd elements with an optional labelled group.

Keyboard

No component-specific keys.

System support

Light and dark themes, logical RTL layout, reduced motion, responsive content, and forwarded public refs.

Source-derived reference

Anatomy and public API

Exported anatomy

These public React parts are read directly from the canonical source during the documentation build.

GummyKbd
GummyKbdGroup

Prop contracts

`GummyKbdGroupProps`

Composes React.HTMLAttributes<HTMLSpanElement> & { separator?: React.ReactNode; }

`GummyKbdProps`

Composes React.HTMLAttributes<HTMLElement>

Troubleshooting

Check behavior before surface.

If the material is missing, confirm the registry-installed shared and component CSS files are imported once.
If interaction differs, preserve this contract: No component-specific keys.
If assistive output differs, preserve this semantic foundation: Native kbd elements with an optional labelled group.
If dark, RTL, or reduced-motion behavior is missing, verify the nearest theme, direction, and media-query boundaries rather than adding page-local overrides.

Implementation decisions

When to use Kbd

Use keyboard notation to document a real supported shortcut, not to make ordinary text look technical. Name keys according to the target platform when conventions differ, explain the action in words, and avoid presenting a shortcut as the sole route to functionality. Check the sequence against the application, operating-system conflicts, remapped keyboards, speech input, mobile environments, and international layouts before publishing the instruction.

Live product source

Inspect the canonical states

The Component Lab exercises real source across default, focus, disabled, responsive, dark, reduced-motion, and RTL contexts.

Open the live Component Lab

Interactive inspection

Try Kbd in context

Load the real component preview when you are ready to interact with its responsive, theme, and direction controls.

Editable source

Read before you install

Canonical Base UI or native source

The registry payload stays off the initial page request.