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.


Examples

Use when you need to present merchants with a list of items or terms alongside descriptions and explanations.

Drag to resize example
<DescriptionList
  items={[
    {
      term: 'Logistics',
      description: 'The management of products or other resources as they travel between a point of origin and a destination.',
    },
    {
      term: 'Sole proprietorship',
      description: 'A business structure where a single individual both owns and runs the company.',
    },
    {
      term: 'Discount code',
      description: 'A series of numbers and/or letters that an online shopper may enter at checkout to get a discount or special offer.',
    },
  ]}
/>
Name
Type
Description
items
Item[]
Collection of items for list

Purpose

Put the merchant first by identifying the problem they face and the component that helps them solve it.

Problem

Merchants may need to reference a range of concepts to understand how they work at Shopify.

Solution

Description lists associate a list item with a definition or description in a format that’s easy to reference and scan.


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)
  • Discount code

  • Discount Code

Term description

Terms descriptions should be:

  • Directly related to the term they’re describing
  • Discount code: A series of numbers and/or letters that an online shopper may enter at checkout to get a discount or special offer.

  • Discount code: Having a sale on your store is a great way to sell products quickly.

  • 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
  • Abandoned checkout: The details of a checkout that was started but not completed, including the products added and the customer’s details.

  • Abandoned checkout: Details of products added to checkout but not purchased