Get Started
Input
Feedback
Display
Installation
i18n
⌘⇧⌥⌃Ctrl+B
import { Kbd, KbdGroup } from "@/components/ui/kbd"
export function KbdDemo() {Installation#
pnpm dlx shadcn@latest add https://ui.tyap.me/r/styles/base/kbd.jsonnpx shadcn@latest add https://ui.tyap.me/r/styles/base/kbd.jsonyarn dlx shadcn@latest add https://ui.tyap.me/r/styles/base/kbd.jsonbunx --bun shadcn@latest add https://ui.tyap.me/r/styles/base/kbd.json
Copy and paste the following code into your project.
import { cn } from "@/lib/utils"
function Kbd({ className, ...props }: React.ComponentProps<"kbd">) {
return (
<kbd
data-slot="kbd"
className={cn(
"pointer-events-none inline-flex items-center justify-center select-none",
className
)}
{...props}
/>
)
}
function KbdGroup({ className, ...props }: React.ComponentProps<"div">) {
return (
<kbd
data-slot="kbd-group"
className={cn("inline-flex items-center", className)}
{...props}
/>
)
}
export { Kbd, KbdGroup }
Update the import paths to match your project setup.
Usage#
import { Kbd } from "@/components/ui/kbd"<Kbd>Ctrl</Kbd>Composition#
Use the following composition to build Kbd and KbdGroup:
Kbd
KbdGroup
├── Kbd
└── KbdExamples#
Group#
Use the KbdGroup component to group keyboard keys together.
Use Ctrl + BCtrl + K to open the command palette
import { Kbd, KbdGroup } from "@/components/ui/kbd"
export function KbdGroupExample() {Button#
Use the Kbd component inside a Button component to display a keyboard key inside a button.
import { Button } from "@/components/ui/button"
import { Kbd } from "@/components/ui/kbd"
Tooltip#
You can use the Kbd component inside a Tooltip component to display a tooltip with a keyboard key.
import { Button } from "@/components/ui/button"
import { ButtonGroup } from "@/components/ui/button-group"
import { Kbd, KbdGroup } from "@/components/ui/kbd"Input Group#
You can use the Kbd component inside a InputGroupAddon component to display a keyboard key inside an input group.
⌘K
import { SearchIcon } from "lucide-react"
import {RTL#
To enable RTL support in shadcn/ui, see the RTL configuration guide.
⌘⇧⌥⌃Ctrl+B
"use client"
import * as React from "react"API Reference#
Kbd#
Use the Kbd component to display a keyboard key.
| Prop | Type | Default |
|---|---|---|
className | string | `` |
<Kbd>Ctrl</Kbd>KbdGroup#
Use the KbdGroup component to group Kbd components together.
| Prop | Type | Default |
|---|---|---|
className | string | `` |
<KbdGroup>
<Kbd>Ctrl</Kbd>
<Kbd>B</Kbd>
</KbdGroup>