Description

Types

Type

Image

Usage

Simple list

The most common list is a flat collection of objects.

Checkbox list

A list where the user can select multiple options.

Tree list

A hierarchical list with expanding and collapsing nodes which contain nested items. See the Tree page.

Usage & Behavior

General guidelines

Structure

Single-line list

Two-line list

Three-line list

Full list

Single Item

Single item with icon / image

Single item with multi select

image-20240103-094739.png

Internal Logic

Lists should be ordered in logical ways that make the content easy to scan. Order the list using one of these rules:

States

State

Image

Regular

image-20240404-081201.png

Hover

image-20240404-081257.png

Active

image-20240404-081332.png

Active, Hover

image-20240404-081403.png

Disabled

image-20240404-080132.png

Focused

image-20240404-081545.png

Focused, Hover

image-20240404-081628.png

Focused, Active

image-20240404-081704.png

Focused, Disabled

image-20240404-081729.png

Interaction

Selection

There are three possible selection modes:

Interaction

Screenshot

Single Selection

  • Only one item can be selected.

  • Clicking anywhere on the item row will select it.

  • One item must always be selected.

  • Selecting an item will automatically deselect the previously-selected item.

Single Select-20240529-093756.jpg

Multi-select checkboxes

  • Clicking on any checkbox or anywhere on the item row will select or deselect the corresponding item.

  • Items can also be selected by holding the ctrl or shift keys on the keyboard and clicking anywhere on the item.

Multi-20240529-093413.jpg

Smart Selection

  • On hover anywhere over an item, a checkbox appears.

  • Clicking anywhere on the item row will select it. As with Single selection, selecting an item in this way will automatically deselect the previously-selected item.

  • Additionally, the user can select multiple items in one of two ways:

    • By directly checking any item checkboxes.

    • By holding the ctrl or shift keys on the keyboard and clicking anywhere on the item.

  • When relevant, an Apply button will appear, allowing the user to apply the selected items.

Smart-20240529-093343.png

Search

When the list includes a search field and the user starts typing the characters, the text “<number> found” or “<number> found out of <total no.>” will be displayed instead of the total no. of items.

image-20231227-144006.png

Best practices

Use:

Don’t use:

General:

Accessibility compliance

Unless otherwise specified, see our general compliance information in Fundamentals - Accessibility.

Focus management

Keyboard

Description

Tab

  • From a previous component

    • If no item is selected, moves focus to the first item in the list.

    • If an item is selected, moves focus to the first selected item.

  • From the last item in the list, will navigate to the next component

Shift + Tab

  • From the next component

    • If no item is selected, moves focus to the first item on the list.

    • If an item is selected, moves focus to the first selected item.

  • From the first item in the list, will navigate to the previous component

Space

Selects or actions the item.

Enter

Selects or actions the item.

Esc

N/A

Arrows

  • Up/Down - Navigates between the items accordingly. Focus will stop on either the first or last item.

  • Holding down the key will scroll continuously.

Page Up/Home

Navigates to the first item.

Page Down/End

Navigates to the last item.

a-z, A-Z

  • Moves focus to the next list item with a label starting with the typed character(s), if such an item exists.

  • Typing multiple characters in rapid succession moves the focus to the next list item starting with the string of typed characters.

  • If no item labels match the typed character(s), the focus does not move.

Design

Zeplin link

Screen thumbnail

https://zpl.io/V1XnDX2

https://zpl.io/VOZ6QL2

https://zpl.io/aX06xpa

https://zpl.io/aBL3oe2

https://zpl.io/b6qGrNa

Code