Examples
Responsive detail grid
Use term and definition semantics to present related read-only values.
- Name
- Avery Nguyen
- Role
- Workspace owner
- Status
- Active
- Joined
- September 12, 2026
Workspace member details
import { Descriptions, DescriptionsItem } from "@phuctech/ui/components/descriptions";
export function Example() {
return (
<Descriptions aria-label="Workspace member details" columns={2}>
<DescriptionsItem label="Name">Avery Nguyen</DescriptionsItem>
<DescriptionsItem label="Role">Workspace owner</DescriptionsItem>
<DescriptionsItem label="Status">Active</DescriptionsItem>
<DescriptionsItem label="Joined">September 12, 2026</DescriptionsItem>
</Descriptions>
);
}
Bordered invoice summary
A subtle grid boundary helps users compare a compact set of values.
- Invoice
- INV-2048
- Amount
- $240.00
- Status
- Awaiting payment
Bordered invoice summary
import { Descriptions, DescriptionsItem } from "@phuctech/ui/components/descriptions";
export function Example() {
return (
<Descriptions aria-label="Invoice summary" columns={3} bordered>
<DescriptionsItem label="Invoice">INV-2048</DescriptionsItem>
<DescriptionsItem label="Amount">$240.00</DescriptionsItem>
<DescriptionsItem label="Status">Awaiting payment</DescriptionsItem>
</Descriptions>
);
}
Try the layout
Compare the responsive column count and boundary treatment using one fixture.
- Project
- Northstar
- Owner
- Avery Nguyen
- Description
- A longer value wraps inside its grid cell so it remains readable at narrow widths.
- State
- In review
Descriptions property playground
import { Descriptions, DescriptionsItem } from "@phuctech/ui/components/descriptions";
export function Example() {
return (
<Descriptions aria-label="Project details" columns={2} bordered>
<DescriptionsItem label="Project">Northstar</DescriptionsItem>
<DescriptionsItem label="Owner">Avery Nguyen</DescriptionsItem>
<DescriptionsItem label="Description">A longer value wraps inside its grid cell so it remains readable at narrow widths.</DescriptionsItem>
<DescriptionsItem label="State">In review</DescriptionsItem>
</Descriptions>
);
}
When to use
Use Descriptions on a detail view or read-only summary when each label names one value. Use Table for repeated records with the same row and column relationships, and Field for values the user can change.
Usage
import { Descriptions, DescriptionsItem } from "@phuctech/ui/components/descriptions";
<Descriptions aria-label="Member details" columns={2}>
<DescriptionsItem label="Name">Avery Nguyen</DescriptionsItem>
<DescriptionsItem label="Role">Workspace owner</DescriptionsItem>
</Descriptions>Descriptions renders a dl; each item renders a dt and dd. Values may wrap naturally, including when a column is narrow.
API
Tokens
Accessibility
Descriptions uses the native dl, dt, and dd relationship. Add an aria-label when a surrounding heading does not already name the detail group.
Do and don’t
Use clear terms and include units in values where they are not self-evident.
Use Descriptions for editable form controls or as a substitute for a repeated data table.
Related
- Table compares repeated tabular records.
- Field labels editable controls.
- Typography defines shared text hierarchy.