Elements

Kbd

A small pill representing a single keyboard key, for shortcut hints.

vue
<UiKbd />

Options

One block per prop — what it does, and what it looks like set.

Value

value is the key to display — pass 'meta', 'enter' or 'shift' and it renders as that platform's symbol or label, so the same markup reads correctly on macOS and Windows.

⌘⇧Alt↵DelEscTab↑↓←→

Examples

The component in real use: compositions that answer "how do I build X with this", rather than one prop at a time.

Default slot — for any literal character

⌘+K

API Reference

Generated from the component's source — props, slots and emits as the component actually declares them.

Props

Prop
Type
Default
Description
string
—
The key name to display (e.g. 'meta', 'enter', 'shift'); mapped to its platform-specific symbol or label automatically.

Slots

Slot
default