Lists

Component status:Beta

A List vertically organizes related content.

Examples

Unordered List

• List item 1
  • List item 1A
  • List item 1B
• List item 2
• List item 3
  • List item 3A
    • List item 3Ai
    • List item 3Aii
  • List item 3B

<ul class="bux-list-ul">
  <li>
    List item 1
    <ul>
      <li>List item 1A</li>
      <li>List item 1B</li>
    </ul>
  </li>
  <li>List item 2</li>
  <li>
    List item 3
    <ul>
      <li>
        List item 3A
        <ul>
          <li>List item 3Ai</li>
          <li>List item 3Aii</li>
        </ul>
      </li>
      <li>List item 3B</li>
    </ul>
  </li>
</ul>

<ul class='bux-list-ul'>
	{% for item in list_items %}
		{% if item.level2_items %}
			<li>
				{{- item.text -}}
				<ul>
					{% for item in item.level2_items %}
						{% if item.level3_items %}
							<li>
								{{- item.text -}}
								<ul>
									{% for item in item.level3_items %}
										<li>{{- item.text -}}</li>
									{% endfor %}
								</ul>
							</li>
						{% else %}
							<li>{{- item.text -}}</li>
						{% endif %}
					{% endfor %}
				</ul>
			</li>
		{% else %}
			<li>{{- item.text -}}</li>
		{% endif %}
	{% endfor %}
</ul>

Ordered List

1. List item 1
   1. List item 1A
   2. List item 1B
2. List item 2
3. List item 3
   1. List item 3A
      1. List item 3Ai
      2. List item 3Aii
   2. List item 3B

<ol class="bux-list-ol">
  <li>
    List item 1
    <ol>
      <li>List item 1A</li>
      <li>List item 1B</li>
    </ol>
  </li>
  <li>List item 2</li>
  <li>
    List item 3
    <ol>
      <li>
        List item 3A
        <ol>
          <li>List item 3Ai</li>
          <li>List item 3Aii</li>
        </ol>
      </li>
      <li>List item 3B</li>
    </ol>
  </li>
</ol>

<ol class="bux-list-ol">
	{% for item in list_items %}
		{% if item.level2_items %}
			<li>
				{{- item.text -}}
				<ol>
					{% for item in item.level2_items %}
						{% if item.level3_items %}
							<li>
								{{- item.text -}}
								<ol>
									{% for item in item.level3_items %}
										<li>{{- item.text -}}</li>
									{% endfor %}
								</ol>
							</li>
						{% else %}
							<li>{{- item.text -}}</li>
						{% endif %}
					{% endfor %}
				</ol>
			</li>
		{% else %}
			<li>{{- item.text -}}</li>
		{% endif %}
	{% endfor %}
</ol>

Description List

Term 1

This is the definition of the first term.

Term 2

This is the definition of the second term.

Term 3

This is the definition of the third term.

<dl class="bux-dl">
  <dt>Term 1</dt>
  <dd>This is the definition of the first term.</dd>
  <dt>Term 2</dt>
  <dd>This is the definition of the second term.</dd>
  <dt>Term 3</dt>
  <dd>This is the definition of the third term.</dd>
</dl>

<dl class="bux-dl">
	{% for item in list_items %}
		<dt>{{ item.term }}</dt>
		<dd>{{ item.desc }}</dd>
	{% endfor %}
</dl>

Usage

Dos

• Use an “Unordered List” when you don’t need to convey a specific order for list items
• Use an “Ordered List” when the sequence or count of items is important
• Use a “Description List” with terms and descriptions, such as a glossary, or to display metadata, such as contact details

Don’ts

• Don’t overuse lists for long-form or narrative content; rely on paragraphs

References

• U.S. Web Design System (USWDS) Lists