Skip to the content

DescriptionList

A semantic list of key/value pairs (<dl>, <dt>, <dd>) under an optional title — balances, order summaries, transaction details. Keys and values accept any ReactNode.
Data Display

When to use

Use when
  • A block of related label/value pairs: an account summary, a receipt, deposit details.
  • The term → description pairing matters to screen readers.
Avoid when
  • Rows with several comparable columns — use Table.
  • A single value with no label — use Text.
  • Editable values — use Field.

Usage

Account summary
Available balance
R$ 1.250,00
In orders
R$ 300,00
Total
R$ 1.550,00
import { DescriptionList } from '@apollion-dsi/core/data-display/description-list';

<DescriptionList
  title="Account summary"
  contents={[
    { key: 'Available balance', value: 'R$ 1.250,00' },
    { key: 'Total', value: <strong>R$ 1.550,00</strong> },
  ]}
/>;

Pass id on an item when the list reorders; it becomes the React key.

Variants

direction="column" stacks each value under its key, for long values (addresses, hashes). dividers draws a thin rule under every row except the last.

Deposit details
Network
Bitcoin (BTC)
Address
bc1qar0srrr7xfkvy5l643lydnw9re59gtzzwf5mdq
<DescriptionList direction="column" dividers contents={rows} />

Spacing

The host gap is the space between each key and its value (default medium in a row, micro in a column). The title and the rows keep their own fixed rhythm. itemProps passes Flex and border props to every row and wins over gap and dividers.

<DescriptionList direction="column" gap="micro" itemProps={{ py: 'xs' }} contents={rows} />

Accessibility

  • Pairs render as <dt> / <dd> inside one <dl>, so screen readers announce terms and values together.
  • The title is bold text, not a heading. Add a heading above the list when it starts a page section.

Properties

Beyond the props above, every component accepts the layout props (spacing, color, flex/grid, sizing, border) — not repeated here.

See also