Skip to content
uiify

Description List

A semantic list of terms and their descriptions.

Browsers
Chrome 123+Firefox 121+Safari 17.5+
Tier
0
Forced layout budget
0 ms
Axe budget
0
SSR compatible
Yes
Published contract
Test harness

Playground

Description List

Status
Active
Project notes
This value is intentionally long to show that detailed content wraps within the available space.

Examples

Project details

Write each term and its details in source order; the native description list supplies the semantics.

Status
Active
Project notes
This value is intentionally long to show that detailed content wraps within the available space.
import { DescriptionDetails, DescriptionList, DescriptionTerm } from "@gunkin/uiify";

export default function Example() {
  return (
    <DescriptionList>
      <DescriptionTerm>Status</DescriptionTerm>
      <DescriptionDetails>Active</DescriptionDetails>
      <DescriptionTerm>Project notes</DescriptionTerm>
      <DescriptionDetails>This value is intentionally long to show that detailed content wraps within the available space.</DescriptionDetails>
    </DescriptionList>
  );
}

API

DescriptionList

PropTypeDefaultDescription
childrenReactNode—DescriptionTerm and DescriptionDetails pairs in source order.
className / style / ref / native dl propsnative dl props—Native description-list props, styles, events, and ref are forwarded.
renderReactElement | ((props, state) => ReactElement)—Replace the rendered element while keeping behavior and accessibility wiring.

DescriptionTerm

PropTypeDefaultDescription
childrenReactNode—Term text naming the following details.
renderReactElement | ((props, state) => ReactElement)—Replace the rendered element while keeping behavior and accessibility wiring.

DescriptionDetails

PropTypeDefaultDescription
childrenReactNode—Description content associated with the preceding term.
renderReactElement | ((props, state) => ReactElement)—Replace the rendered element while keeping behavior and accessibility wiring.

Keyboard

KeyAction

Accessibility

Native dl, dt, and dd semantics in the source order you provide. Keep each description paired with its term; no table roles or action column are added.

Styling hooks

data-uiify-description-listdata-uiify-description-termdata-uiify-description-detailsdata-part