Skip to main content
It can be thought of as analogous to the <dl>, <dt>, and <dd> HTML tags.

Example

TypeScript

Props

string
An optional title to display in the description list.
React.ReactNode
required
The <DescriptionList.Item />s and optional <DescriptionList.Menu /> with the information to display.
An <DescriptionList /> component can only have <DescriptionList.Item />s and an optional <DescriptionList.Menu /> as children.

<DescriptionList.Item />

An item with information.

Props

string
required
The label of the information.
Icon
An optional Attio Icon.
React.ReactNode
required
The information corresponding to the label.
An <DescriptionList.Item /> can contain either text (including <Link />s), or <Badge />s, but never both.

<DescriptionList.Menu />

A dropdown menu for the description list, displayed as a three-dot icon button. It aligns with the title if provided, or with the first item if no title is set.

Props

React.ReactNode
required
The <DescriptionList.Menu.Item />s to display in the menu.

<DescriptionList.Menu.Item />

A menu item within a <DescriptionList.Menu />.

Props

string
required
The label of the menu item.
Icon
An optional Attio Icon for the menu item.
'primary' | 'danger'
The visual variant of the menu item. Use "danger" for destructive actions.
() => void
required
The callback to invoke when the menu item is selected.