Description List

Semantic dl, dt and dd list of label and value pairs in a responsive two column grid with dividers. Good for record details and summaries in Tailwind apps.

src/registry/ui/description-list.tsx/r/description-list.json

Installation#

bash
npx shadcn@latest add @minidev/description-list

MiniDev UI is in the shadcn registry directory, so the short form works with no setup. Older CLI versions can use the full URL: npx shadcn@latest add https://ui.minidev.pro/r/description-list.json

Usage#

tsx
import { DescriptionList } from "@/components/ui/description-list"

export function Example() {
  return (
    <DescriptionList className="max-w-lg" items={[
      { label: "Workspace", value: "MiniDev" },
      { label: "Plan", value: "Agency" },
      { label: "Region", value: "us-east-1" },
      { label: "Status", value: <span className="inline-flex items-center gap-2"><StatusDot tone="success" /> Healthy</span> },
    ]} />
  )
}

API reference#

DescriptionList props
PropTypeDefault
itemsDescriptionItem[]SAMPLE_ITEMS
classNamestring-

Examples#

All layout components