# Description List

> The key/value details panel every admin screen needs: a semantic dl with a titled header and action, rows that put each term beside its value and stack in narrow containers, or a term-over-value grid. Values can carry a copy button that confirms with a check, terms a hint tooltip, IDs set in monospace, and empty values show a quiet dash. Shown as payment details.

- Slug: `description-list`
- Category: [Tables](https://www.assembli.design/category/tables.md)
- Type: component
- Tags: description-list, details, key-value, properties, copy, dl, admin
- npm dependencies: lucide-react
- shadcn/ui dependencies: none
- Live preview: https://www.assembli.design/preview/description-list
- Page: https://www.assembli.design/components/description-list

![Description List preview](https://www.assembli.design/thumbnails/description-list-light.png)

## Props

Other props pass through to the root element.

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `title` | `React.ReactNode` |  |  |
| `description` | `React.ReactNode` |  |  |
| `action` | `React.ReactNode` |  | A button or link at the end of the header, such as Edit. |
| `variant` | `Variant` | `"rows"` | `rows`: term beside value, divided rows (stacks in narrow containers). `grid`: term over value in a 2–3 column grid. |

## Install

One-time setup (needs a subscription):

1. Add the registry to the project's `components.json`: `{"@assembli":{"url":"https://www.assembli.design/r/{name}.json","headers":{"Authorization":"Bearer ${ASSEMBLI_API_KEY}"}}}` (merge into `"registries"`).
2. Put an API key from https://www.assembli.design/account in `.env.local` as `ASSEMBLI_API_KEY=asm_…`.

Then install with the shadcn CLI (writes `components/description-list/description-list.tsx` and installs dependencies):

```bash
npx shadcn@latest add @assembli/description-list
```

Registry item JSON: https://www.assembli.design/r/description-list.json (send `Authorization: Bearer <api key>`)

## Code

> Component source needs an Assembli subscription ($12/month or $96/year) and an API key sent as `Authorization: Bearer <key>`. To get one without copying anything, POST https://www.assembli.design/api/agent/login (or call the MCP tool connect_account), show the user the link it returns, and poll https://www.assembli.design/api/agent/token for the key. Or subscribe at https://www.assembli.design/pricing and create a key at https://www.assembli.design/account.