@objectifthunes/whiteboard
SAAS PATTERNS

DescriptionList

Label and value pairs as a real <dl>. For read-only detail: an invoice summary, a record's metadata, a Drawer body.


PREVIEW
Row layout (default)
Invoice
INV-2043
Status
Awaiting payment
Amount
€4,280.00
Issued
12 August 2026
Due
11 September 2026
Terms
Net 30
Tags
retainerq3
Reference
PO-2026-08-ACME-RETAINER-Q3-0004182-LONG-VALUE-THAT-WRAPS
Stack layout, for narrow columns
Client
Acme Industries
Contact
billing@acme.example
VAT
IE1234567X
SOURCE
import { DescriptionList } from '@objectifthunes/whiteboard'

<DescriptionList
  items={[
    { label: 'Invoice', value: 'INV-2043' },
    { label: 'Status', value: <Pill tone="warning">Awaiting payment</Pill> },
    { label: 'Amount', value: '€4,280.00' },
  ]}
/>

{/* labels above values, for a narrow column or a Drawer */}
<DescriptionList layout="stack" items={items} />
NOTES

A real <dl>, so the pairing lives in the markup rather than being implied by two columns. Screen readers announce each label with its value.

Use this instead of a two-column table when there is exactly one record. A table of one row makes the reader look for the others.

Values are ReactNode, so a Pill, a TagRow or a link all work. Long unbroken values wrap with overflow-wrap: anywhere rather than forcing the container wider — see the reference row above.

Under 880px the row layout collapses to stacked pairs automatically, so you rarely need layout="stack" for responsiveness alone. Use it when the column is narrow on desktop too, like a Drawer body.