# React Native DescriptionList

> A React Native description list for iOS, Android and the web: terms and their details for order summaries, profiles and About pages, side by side or stacked, in a brand, iOS, Material 3 or web design.

# DescriptionList

Terms and their details, for read-only facts: an order summary, a profile, a device's About page. For rows people press, use a [List](./list).

```tsx
import { DescriptionList } from 'patine-ui';
```

```tsx live
import { Badge, Card, DescriptionList, Text } from 'patine-ui';

export default function Example() {
  return (
    <Card style={{ padding: 16, maxWidth: 420 }}>
      <Text weight="semibold" size="lg">Order #1042</Text>
      <DescriptionList
        items={[
          { term: 'Status', details: <Badge variant="success">Shipped</Badge> },
          { term: 'Placed', details: 'March 3, 2026' },
          { term: 'Customer', details: 'Maya Cohen' },
          { term: 'Ship to', details: '18 Rothschild Blvd, Tel Aviv' },
          { term: 'Total', details: '$248.00' },
        ]}
      />
    </Card>
  );
}
```

## Example: a flight booking

A trip's booking screen: the details people look up at the airport, with the confirmation code ready to copy and the status as a badge.

```tsx live
import { Badge, Card, CardContent, CopyButton, DescriptionList, HStack, Text } from 'patine-ui';

export default function Example() {
  return (
    <Card style={{ width: '100%', maxWidth: 440 }}>
      <CardContent style={{ gap: 8 }}>
        <HStack justify="space-between" align="center">
          <Text weight="semibold" size="lg">Lisbon → Amsterdam</Text>
          <Badge variant="success">Checked in</Badge>
        </HStack>
        <DescriptionList
          items={[
            {
              term: 'Booking code',
              details: (
                <HStack gap="xs" align="center">
                  <Text style={{ fontFamily: 'monospace' }}>K7QX2M</Text>
                  <CopyButton value="K7QX2M" accessibilityLabel="Copy booking code" />
                </HStack>
              ),
            },
            { term: 'Flight', details: 'TP 662 · Airbus A321neo' },
            { term: 'Departs', details: 'Fri, Nov 21 · 07:05, Terminal 1' },
            { term: 'Arrives', details: '10:55 local time' },
            { term: 'Passenger', details: 'Maya Cohen' },
            { term: 'Seat', details: '14A, window' },
            { term: 'Bags', details: '1 cabin bag, 1 checked bag (23 kg)' },
          ]}
        />
      </CardContent>
    </Card>
  );
}
```

## Designs

- **iOS**: Settings › About: the name on the left, the value on the right in gray.
- **Material 3**: gray labels over their values.
- **web**: two columns, gray terms, as Tailwind UI's description lists.
- **brand**: gray terms beside their values.

`orientation` overrides the design's: `'horizontal'` puts the term beside its details, `'vertical'` above.

## Accessibility

A list of items, each read as "Term, details" when the details are text. Rows are at least 44pt tall.

## Props

Also takes `View` props.

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `items` | `{ term, details }[]` | — | The facts. `details` is text or any node. |
| `orientation` | `'horizontal' \| 'vertical'` | the design's | Term beside or above its details. |
| `dividers` | `boolean` | `true` | Hairlines between rows. |
| `styles` | `{ row?, term?, details? }` | — | Slot styles. |
| `theme`, `design` | | | As every component. |
