List Group

A list group is a flexible component that displays a series of content. The content can be read-only text or links that take the user to specific content pages.

Anatomy

List group anatomy
  1. Overline is an optional top divider of every list item.
  2. Tertiary button sets the content of the listed item and enforces the behavior of the CTA.
  3. Underline is an optional bottom divider of every listed item.
  4. Bullet is an optional symbol to enforce the idea of a read-only list item.
  5. Text line defines the listed item.

Usage

When to Use

Use a list group to list several tertiary buttons or text items.

When Not to Use

Don’t use a list group to combine a group of titles or labels with body text. Use an accordion instead.

Variants

List group variants: link, bullet, and text line
Variation
Purpose
Line
Bullet
Sizes

Link list

Use to list clickable items that take users to different content pages.

With overline and with underline, with overline and no underline, no overline and with underline, no overline and no underline

No bullet

SM, MD, LG, XL

Bullet list

Use to list non actionable items and highlight each item of the list.

With overline and with underline, with overline and no underline, no overline and with underline, no overline and no underline

With bullet

XS, SM, MD, LG, XL

Text line list

Use to list non actionable items.

With overline and with underline, with overline and no underline, no overline and with underline, no overline and no underline

No bullet

XS, SM, MD, LG, XL

Types

With Overline and With Underline

Use both lines as dividers between list items to mark an obvious separation between them.

List group type: With overline and with underline
Use mostly with tertiary buttons as items.

With Overline and No Underline

Use only the overline to divide items. This option is more often used inside cards.

List group type: With overline and no underline
Use mostly with tertiary buttons as items.

No Overline and With Underline

Use only the underline as a divider between items.

List group type: No overline and with underline

No Overline and No Underline

No use of lines as dividers. This option is more often used in the footer and for simple text.

List group type: No overline and no underline
Use mostly with text only and bullets, but there are some cases that have the tertiary button as an item.

List Container

Spacing

Ensure that proper space is given between each list item. The distance between each item will depend on the list group size and will be maintained with and without dividers.

List group container spacing

Alignment

The list items are left-aligned within their group container. The alignment of the whole list group in relation to content at the same level of the page should follow a left-spaced pattern.

List group alignment example 1
List group alignment example 2
List group alignment example 3
List group do example

Do use overlines or underlines in list groups inside cards.

Listo group don't example

Don’t use list groups inside cards without overlines or underlines.

List group do example

Do use bullets or simple text in list groups with text-only content.

List group don't example

Don’t use link list groups with text-only content.

Sizing

Sizing affects text size, icon size, and internal padding. The default size is medium, and you can use props to make the list group smaller or larger.

List group on the possible sizes: xs, sm, md, lg, xl

Themes

List group on dark theme
Dark
List group on mid theme
Mid
List group on light theme
Light