Copy to clipboard
⌘K
<KbdGroup>
<Kbd>⌘</Kbd>
<Kbd>K</Kbd>
</KbdGroup>
<KbdGroup>
<Kbd>⌘</Kbd>
<Kbd>K</Kbd>
</KbdGroup><KbdGroup>
<Kbd>⌘</Kbd>
<Kbd>K</Kbd>
</KbdGroup>
Installation
Copy to clipboard
npx @vds-testing/cli add kbd
npx @vds-testing/cli add kbdnpx @vds-testing/cli add kbd
bunx @vds-testing/cli add kbd
bunx @vds-testing/cli add kbdbunx @vds-testing/cli add kbd
pnpm dlx @vds-testing/cli add kbd
pnpm dlx @vds-testing/cli add kbdpnpm dlx @vds-testing/cli add kbd
yarn dlx @vds-testing/cli add kbd
yarn dlx @vds-testing/cli add kbdyarn dlx @vds-testing/cli add kbd
Usage
import { Kbd, KbdGroup } from "@/components/vds/kbd"<Kbd>Ctrl</Kbd>Examples
Group
Use the KbdGroup component to group keyboard keys together.
Copy to clipboard
CtrlShiftK
<KbdGroup>
<Kbd>Ctrl</Kbd>
<Kbd>Shift</Kbd>
<Kbd>K</Kbd>
</KbdGroup>
<KbdGroup>
<Kbd>Ctrl</Kbd>
<Kbd>Shift</Kbd>
<Kbd>K</Kbd>
</KbdGroup><KbdGroup>
<Kbd>Ctrl</Kbd>
<Kbd>Shift</Kbd>
<Kbd>K</Kbd>
</KbdGroup>
Button
Use the Kbd component inside a Button component to display a keyboard key inside a button.
Copy to clipboard
<Button variant="outline">
Accept
<KbdGroup>
<Kbd>⌘</Kbd>
<Kbd>↵</Kbd>
</KbdGroup>
</Button>
<Button variant="outline">
Accept
<KbdGroup>
<Kbd>⌘</Kbd>
<Kbd>↵</Kbd>
</KbdGroup>
</Button><Button variant="outline">
Accept
<KbdGroup>
<Kbd>⌘</Kbd>
<Kbd>↵</Kbd>
</KbdGroup>
</Button>
Tooltip
You can use the Kbd component inside a Tooltip component to display a tooltip with a keyboard key.
Copy to clipboard
Save changes
⌘SPrint document
⌘P<div class="flex gap-2">
<Tooltip>
<TooltipTrigger>
<Button variant="outline">Save</Button>
</TooltipTrigger>
<TooltipContent>
Save changes
<KbdGroup>
<Kbd>⌘</Kbd>
<Kbd>S</Kbd>
</KbdGroup>
</TooltipContent>
</Tooltip>
<Tooltip>
<TooltipTrigger>
<Button variant="outline">Print</Button>
</TooltipTrigger>
<TooltipContent>
Print document
<KbdGroup>
<Kbd>⌘</Kbd>
<Kbd>P</Kbd>
</KbdGroup>
</TooltipContent>
</Tooltip>
</div>
<div class="flex gap-2">
<Tooltip>
<TooltipTrigger>
<Button variant="outline">Save</Button>
</TooltipTrigger>
<TooltipContent>
Save changes
<KbdGroup>
<Kbd>⌘</Kbd>
<Kbd>S</Kbd>
</KbdGroup>
</TooltipContent>
</Tooltip>
<Tooltip>
<TooltipTrigger>
<Button variant="outline">Print</Button>
</TooltipTrigger>
<TooltipContent>
Print document
<KbdGroup>
<Kbd>⌘</Kbd>
<Kbd>P</Kbd>
</KbdGroup>
</TooltipContent>
</Tooltip>
</div><div class="flex gap-2">
<Tooltip>
<TooltipTrigger>
<Button variant="outline">Save</Button>
</TooltipTrigger>
<TooltipContent>
Save changes
<KbdGroup>
<Kbd>⌘</Kbd>
<Kbd>S</Kbd>
</KbdGroup>
</TooltipContent>
</Tooltip>
<Tooltip>
<TooltipTrigger>
<Button variant="outline">Print</Button>
</TooltipTrigger>
<TooltipContent>
Print document
<KbdGroup>
<Kbd>⌘</Kbd>
<Kbd>P</Kbd>
</KbdGroup>
</TooltipContent>
</Tooltip>
</div>
Input group
You can use the Kbd component inside a InputGroupAddon component to display a keyboard key inside an input group.
Copy to clipboard
⌘K
<InputGroup>
<InputGroupInput placeholder="Search..." />
<InputGroupAddon align="inline-end">
<KbdGroup>
<Kbd>⌘</Kbd>
<Kbd>K</Kbd>
</KbdGroup>
</InputGroupAddon>
</InputGroup>
<InputGroup>
<InputGroupInput placeholder="Search..." />
<InputGroupAddon align="inline-end">
<KbdGroup>
<Kbd>⌘</Kbd>
<Kbd>K</Kbd>
</KbdGroup>
</InputGroupAddon>
</InputGroup><InputGroup>
<InputGroupInput placeholder="Search..." />
<InputGroupAddon align="inline-end">
<KbdGroup>
<Kbd>⌘</Kbd>
<Kbd>K</Kbd>
</KbdGroup>
</InputGroupAddon>
</InputGroup>
Anatomy
Kbd- Displays a single keyboard key with proper stylingKbdGroup- Groups multiple Kbd components together
Props
Kbd
| Prop | Type | Default | Description |
|---|---|---|---|
| class | string | - | Additional CSS classes |
KbdGroup
| Prop | Type | Default | Description |
|---|---|---|---|
| class | string | - | Additional CSS classes |