Skip to content
THE COMPONENT LIBRARY
Skip to content

Component reference

DescriptionList

Workspace metadata expressed as terms and descriptions.

Preview

Live preview

Changes apply to this preview only.

Workspace

Settings that do not fit in a form.

Plan
Pro
Seats
12 of 20
Storage
42 GB of 100 GB
Region
eu-west-3
Renewal
19 Oct 2026

Deployment

A bordered list for a compact summary.

Environment
production
Commit
fde3d86
Status
ready

Width adapts to the available space

More examples

Different configurations and compositions using the real Pimolu API. Each preview runs independently and follows the site appearance.

Layouts

stacked puts the term above the value; inline puts them side by side.

Open preview

Variants

Enumerated from descriptionListVariantMap: plain, divided and bordered.

Open preview

Sizes

Enumerated from descriptionListVariantMap: sm, md and lg.

Open preview

Usage

Use this pattern for name/value details rather than a grid of unrelated labels.

API reference

Generated from the public TypeScript declarations. Native HTML attributes are inherited where the component extends them; this reference includes Pimolu props and selected common native attributes.

PimoluDescriptionListProps

Type source
PimoluDescriptionListProps public API
NameTypeDefaultDescription
layout"stacked" | "inline" | undefined"stacked"Layout of each term/details pair. Defaults to "stacked".
variant"plain" | "divided" | "bordered" | undefined"divided"Visual treatment. Defaults to "divided".
size"sm" | "md" | "lg" | undefined"md"Row density. Defaults to "md".
childrenRequiredReactNode—Public Pimolu prop; see the source declaration for details.
defaultValuestring | number | readonly string[] | undefined—Standard React/HTML attribute.
classNamestring | undefined—Standard React/HTML attribute.
styleCSSProperties | undefined—Standard React/HTML attribute.
aria-labelstring | undefined—Defines a string value that labels the current element.
onChangeChangeEventHandler<HTMLDListElement, Element> | undefined—Standard React/HTML attribute.
onClickMouseEventHandler<HTMLDListElement> | undefined—Standard React/HTML attribute.
layout

"stacked" | "inline" | undefined

Default: "stacked"

Layout of each term/details pair. Defaults to "stacked".

variant

"plain" | "divided" | "bordered" | undefined

Default: "divided"

Visual treatment. Defaults to "divided".

size

"sm" | "md" | "lg" | undefined

Default: "md"

Row density. Defaults to "md".

childrenRequired

ReactNode

No default extracted.

Public Pimolu prop; see the source declaration for details.

defaultValue

string | number | readonly string[] | undefined

No default extracted.

Standard React/HTML attribute.

className

string | undefined

No default extracted.

Standard React/HTML attribute.

style

CSSProperties | undefined

No default extracted.

Standard React/HTML attribute.

aria-label

string | undefined

No default extracted.

Defines a string value that labels the current element.

onChange

ChangeEventHandler<HTMLDListElement, Element> | undefined

No default extracted.

Standard React/HTML attribute.

onClick

MouseEventHandler<HTMLDListElement> | undefined

No default extracted.

Standard React/HTML attribute.

PimoluDescriptionItemProps

Type source
PimoluDescriptionItemProps public API
NameTypeDefaultDescription
termRequiredReactNode—Public Pimolu prop; see the source declaration for details.
detailsRequiredReactNode—Public Pimolu prop; see the source declaration for details.
classNamestring | undefined—Public Pimolu prop; see the source declaration for details.
termRequired

ReactNode

No default extracted.

Public Pimolu prop; see the source declaration for details.

detailsRequired

ReactNode

No default extracted.

Public Pimolu prop; see the source declaration for details.

className

string | undefined

No default extracted.

Public Pimolu prop; see the source declaration for details.

Accessibility

  • Keep terms associated with their descriptions and preserve a sensible reading order.
Read the accessibility guide →