Description list
Description lists are a way to organize and explain related information. They’re particularly useful when you need to list and define terms such as in a glossary.
Props
No props found for this component, run `yarn gen:docs` to generate component meta first.
Best practices
Description lists should:
- Contain terms and associated explanations, or descriptions for each term.
- Provide information that isn’t action-oriented.
- Not be an excuse for using unnecessarily complicated or jargon-filled language. Generally, if merchants need a description list to understand the language in Shopify, we should look for opportunities to simplify the language.
- Not be used to upsell merchants on a feature or service.
Content guidelines
Terms
Terms should be:
- Written in sentence case (the first word capitalized, the rest lowercase)
Term description
Terms descriptions should be:
- Directly related to the term they’re describing
- Written to describe the merchant benefit or utility
- No more than one or two short sentences in length
- Written in sentence case with all appropriate punctuation, including ending each sentence with a period
- Conversational by using articles (the, a, an)
- Written using plain language
Related components
- To create a list of actions or navigation, use the action list component.
Accessibility
The description list component produces a description list wrapper (<dl>), terms (<dt>), and definitions (<dd>) to convey the relationships between the list items to assistive technology users.