Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents

Description

  • Lists are continuous, vertical indexes of text and images.

  • They are composed of items containing primary and in some cases supplemental information, which can be shown as text, icons, or images.

  • The component may be part of a page layout or in a Popover. They also often appear as a sub-component within a larger element, such as a Drop-down Menu, Drag and Drop, or Combo Box.

Image Removed
Image Added
Image Removed
Image Added
Image Removed
Image Added

Types

Type

Image

Usage

Simple list

Image Removed
Image Added

The most common list is a flat collection of objects.

Check box

Checkbox list

Image Removed
Image Added

A list where the user can select multiple options.

Tree list

Image Removed

Image Added

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

Usage & Behavior

General guidelines

Structure

  • List items must have

...

  • a label, with the main object name. If the entire name does not fit, it can be truncated and a Tooltip can be used on hover.

  • List items can optionally also have:a

    • A leading icon. These should only be used if the list can contain several types of

    object
    • objects. If all items are of the same type, an icon should not be used.

    a
    • A leading image.

    up
    • Up to 2 secondary lines of text. Secondary lines cannot have their own leading icons or images.

    extra
    • Extra metadata, such as a tag, text, or an icon. These should be positioned to the right of the item, centered vertically.

    up
    • Up to 2 action icons, such as delete. These should only appear on hover or when an item is selected. They should be positioned to the right of the item, centered vertically (replacing the extra metadata, if exists).

  • For lists which support multi-select, the number of selected items will be displayed in brackets to the right of the total number of items. If no item is selected it should display “(0 selected).

Single-line list

Two-line list

Three-line list

Full list

Image Removed
Image Added
Image Removed
Image Added
Image Removed
Image Added

Single Item

Image Removed
Image Added
Image Removed
Image Added
Image Removed
Image Added

Single item with icon / image

Image Removed
Image Added
Image Removed
Image Added
Image Removed
Image Added

Single item with multi select

Image Removed
Image Added
Image Removed
Image Added
Image Removed
Image Added
  • Lists can also have:a

    • A preceding label at the top of the list,

    to inform the user about the
    • showing the total number of items included in the list.

    a
    • A Search field on long lists, allowing users to find items easily.

    a

...

Internal Logic

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

  • Alphabetical. If there are more than 8 options available, sort them alphabetically. This helps the user to find the right option quickly. Sort currencies, names, and similar content alphabetically.

  • Numeric. Sort numeric values in a sequential order, with the lowest number first.

  • Chronological. Sort time-related information into chronological order, with the most recent first.

States

State

Image

Regular

Image Removed
image-20240404-081201.pngImage Added

Hover

image-20240404-081257.pngImage Added
Image Removed

Active

image-20240404-081332.pngImage Added

Active, Hover

Image Removed
image-20240404-081403.pngImage Added

Disabled

Image Removed
image-20240404-080132.pngImage Added

Focused

Image Removed
image-20240404-081545.pngImage Added

Focused, Hover

Image Removed
image-20240404-081628.pngImage Added

Focused, Active

Image Removed
image-20240404-081704.pngImage Added

Focused, Disabled

Image Removed
image-20240404-081729.pngImage Added

Interaction

  • On hover, the row will be highlighted and Check Boxes Checkboxes or Icon Buttons will appear, where applicable.

  • When the label is truncated (item name), hovering over it will show a Tooltip with the full label.

  • Items in the header area, including the search bar and list title, should remain sticky when the list is scrolled.

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.

Image Removed

Single Select-20240529-093756.jpgImage Added

Multi-select

check boxes

checkboxes

  • Clicking on

a check box
  • any checkbox or anywhere on the item row will select or deselect

an item. This can be repeated for multiple items in the list
  • the corresponding item.

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

Image Removed

Multi-20240529-093413.jpgImage Added

Smart Selection

  • On hover anywhere over an item, a

check box
  • 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

check boxes
  • clicking any other items (either the check box or the label) will select them.

      • checkboxes.

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

    In this case:

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

    Smart-20240529-093343.pngImage Added

    Image Removed

    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.

    ...

    Best practices

    Use:

    • when there is a need to select one or more items from a list.

    • when you want to show relevant content for each list item.

    • when content may vary between rows (contrary to a data table, which is more strict in nature).

    ...

    • For long, complex lists where grouping and categorisation could be applied → use a Tree.

    • For items with multiple attributes which need to be displayed → use Data Tables.

    General:

    • An optional Search field can be used for long, scrolling lists, to help the user find items easily.

    • Visual elements, such as leading icons and images, can help the user to scan and grasp a large amount of information.

    ...

    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

    Image Removed

    Image Added

    https://zpl.io/VOZ6QL2

    Image Removed
    Image Added

    https://zpl.io/aX06xpa

    Image Removed

    Image Added

    https://zpl.io/aBL3oe2

    Image Removed
    Image Added

    https://zpl.io/b6qGrNa

    Image Removed
    Image Added

    Code

    ...