Content

Kbd

Keyboard shortcuts.

Install

Install
npx shadcn@latest add http://localhost:3000/r/kbd.json

Usage

kbd-example.tsx
"use client"

import { Kbd, KbdGroup } from "@/components/ui/kbd"

export function Example() {
  return (
    <div className="flex items-center gap-2 text-sm text-muted-foreground">
      Open search{" "}
      <KbdGroup>
        <Kbd>⌘</Kbd>
        <Kbd>K</Kbd>
      </KbdGroup>
    </div>
  )
}

API

KbdKbdGroup
TypeScript
function Kbd(props: React.ComponentProps<"kbd">)

function KbdGroup(props: React.ComponentProps<"div">)
Source code +
components/ui/kbd.tsx
import { cn } from "cn"

function Kbd({ className, ...props }: React.ComponentProps<"kbd">) {
  return (
    <kbd
      data-slot="kbd"
      className={cn(
        "pointer-events-none inline-flex h-5 w-fit min-w-5 items-center justify-center gap-1 rounded-lg bg-muted px-1 font-sans text-xs font-medium text-muted-foreground select-none in-data-[slot=input-group]:bg-input in-data-[slot=tooltip-content]:bg-background/20 in-data-[slot=tooltip-content]:text-background dark:in-data-[slot=tooltip-content]:bg-background/10 [&_svg:not([class*='size-'])]:size-3",
        className
      )}
      {...props}
    />
  )
}

function KbdGroup({ className, ...props }: React.ComponentProps<"div">) {
  return (
    <kbd
      data-slot="kbd-group"
      className={cn("inline-flex items-center gap-1", className)}
      {...props}
    />
  )
}

export { Kbd, KbdGroup }

Registry JSON ↗