DescriptionList
Aligned names and values with the semantics of a description list.
Live — this one is real
- Package
- mizu-ui
- License
- MIT
- Format
- ES modules
Usage
import { DescriptionList } from "mizu-ui";
export function Example() {
return (
<DescriptionList
items={[
{ label: "Package", value: "mizu-ui" },
{ label: "License", value: "MIT" },
{ label: "Format", value: "ES modules" },
]}
/>
);
}
Source & setup
Add this component to your project with the shadcn CLI. The command copies its source into your configured UI directory, with base.css, Mizu’s tokens, and the stylesheets that hold its rules. Each rule lives in one stylesheet, so components you add together never repeat CSS. In a project without a components.json, run npx shadcn@latest init 0xuser64bit/mizu/preset first: plain init installs shadcn’s theme into your global CSS. Then load the fonts.
npx shadcn@latest add 0xuser64bit/mizu/description-listEvery component imports from its own path, its name in kebab case. Its source, data/Records.tsx, also holds Stat, Timeline and ComparisonTable. Each has its own command and path; adding one after this copies only its small entry file. To paste the example, replace its mizu-ui import with:
import { DescriptionList } from "@/components/ui/mizu/description-list";For npm imports, import mizu-ui/styles.css once. Fonts are optional via mizu-ui/fonts.css. Override --mizu-* tokens or use className for local styling. Uses native React and CSS; install the package peers for root imports. A Server Component: it renders on the server, with no client JavaScript of its own.
Inspect data/Records.tsx
Source is included in the npm package under src/data/Records.tsx.
Props
| Prop | Type | Default | Description |
|---|---|---|---|
| items | {label: string; value: ReactNode}[] | — | Terms and descriptions. |
Accessibility
Native dl/dt/dd relationships. Values can contain links or controls.
Motion
Static, reflowing layout.