List group

React Bootstrap 5 List group component

List groups are a flexible and powerful component for displaying a series of content. Modify and extend them to support just about any content within.

Note: Read the API tab to find all available options and advanced customization

Basic example

The most basic list group is an unordered list with list items and the proper classes. Build upon it with the options that follow, or with your own CSS as needed.

Small

If you need a more compact list, pass small as prop which will reduce the padding of the items in the list.

Active items

Add active property to a <MDBListGroupItem> to indicate the current active selection.

Disabled items

Add disabled property to a <MDBListGroupItem> to make it appear disabled. Note that some elements with .disabled will also require custom JavaScript to fully disable their click events (e.g., links).

Links and buttons

Use tag="a" or <tag="button"> property to create actionable list group items with hover, disabled, and active states by adding action property. We separate these pseudo-classes to ensure list groups made of non-interactive elements (like <li>s or <div>s) don’t provide a click or tap affordance.

Be sure to not use the standard .btn classes here.

No borders

Pass noBorders as a prop to the items to remove all the borders.

Numbered

Pass numbered as a prop to opt into numbered list group items. Numbers are generated via CSS (as opposed to a <ol>s default browser styling) for better placement inside list groupt items and allow for better customization.

Numbers are generated by counter-reset on the <ol>, and then styled and placed with a ::before pseudo-element on the <li> with counter-increment and content.

These work great with custom content as well.

Horizontal

Add horizontal property to change the layout of list group items from vertical to horizontal across all breakpoints. Alternatively, choose a responsive variant using horizontalSize="sm|md|lg|xl|xxl" to make a list group horizontal starting at that breakpoint’s min-width. Currently horizontal list groups cannot be combined with flush list groups.

ProTip: Want equal-width list group items when horizontal? Add .flex-fill to each list group item.

Contextual classes

Use color property to style list items with a stateful background and color.

color property also works with action property. Note the addition of the hover styles here not present in the previous example. Also supported is the active state; apply it to indicate an active selection on a contextual list group item.

Conveying meaning to assistive technologies:
Using color to add meaning only provides a visual indication, which will not be conveyed to users of assistive technologies – such as screen readers. Ensure that information denoted by the color is either obvious from the content itself (e.g. the visible text), or is included through alternative means, such as additional text hidden with the .visually-hidden class.

Badges

Add badges to any list group item to show unread counts, activity, and more with the help of some flexbox utilities.

Custom content

Add nearly any HTML within, even for linked list groups like the one below, with the help of flexbox utilities.

Checkboxes

Place Bootstrap’s checkboxes and radios within list group items and customize as needed. You can use them without <label>s, but please remember to include an aria-label attribute and value for accessibility.

And if you want tag="label"s as the <MDBListGroupItem> property for large hit areas, you can do that, too.

JavaScript behavior

Use the tab JavaScript plugin to extend our list group to create tabbable panes of local content.

Additional examples

A few additional, practical examples with different types of content and elements.

Grid list

John Doe

john.doe@gmail.com

Alex Ray

alex.ray@gmail.com

Kate Hunington

kate.hunington@gmail.com

Soraya Letto

soraya.letto@gmail.com

Zeynep Dudley

zeynep.dudley@gmail.com

Ayat Black

ayat.black@gmail.com

Show code

This is a mobile version of the documentation.

View this website on the desktop to copy & edit the source code of the component.

Complex grid list

John Doe

john.doe@gmail.com

Active

Message Call

Alex Ray

alex.ray@gmail.com

Onboarding

Message Call

Kate Hunington

kate.hunington@gmail.com

Awaiting

Message Call

Michael Bale

michael.bale@gmail.com

Removed

Message Call

Show code

This is a mobile version of the documentation.

View this website on the desktop to copy & edit the source code of the component.

Related resources