Skip to contentSkip to navigationSkip to topbar
Figma
Star

Description List

Version 4.2.0GithubStorybookPeer review pending

A Description List is a set or sets of terms and their definitions, or details, used to display data.

Installation

Installation page anchor
yarn add @twilio-paste/description-list - or - yarn add @twilio-paste/core
import {DescriptionList, DescriptionListSet, DescriptionListTerm, DescriptionListDetails} from '@twilio-paste/core/description-list';

const Component = () => (
  <DescriptionList>
    <DescriptionListSet>
      <DescriptionListTerm>Paste</DescriptionList>
      <DescriptionListDetails>A design system used to build accessible, cohesive, and high-quality customer experiences at Twilio.</DescriptionListDetails>
    </DescriptionListSet>
  </DescriptionList>
);

DescriptionList

DescriptionList page anchor

element

Overrides the default element name to apply unique styles with the Customization Provider

Type
string
Default
'DESCRIPTION_LIST'

element

Overrides the default element name to apply unique styles with the Customization Provider

Type
string
Default
'DESCRIPTION_LIST_TERM'

element

Overrides the default element name to apply unique styles with the Customization Provider

Type
string
Default
'DESCRIPTION_LIST_DETAILS'

element

Overrides the default element name to apply unique styles with the Customization Provider

Type
string
Default
'DESCRIPTION_LIST_SET'