List group
Bootstrap list group
Note: We are transitioning MDB4 to a legacy version and focusing on developing MDB5.
While we'll continue to support for the transition period, we encourage you to migrate to
MDB5. We're offering a huge discount on MDB5 PRO to help with your transition,
enabling you to leverage the full potential of the latest version. You can find more information here.
upgrade with discount
Bootstrap list groups are a flexible component which displays not only simple lists of elements but also complex custom content.
Note: See also Treeview component which allows showing items of the list group in the hierarchical order.
Basic example
The most basic list group is an unordered list with list items and the proper classes. You may build upon it with the options that follow, or with your own CSS as needed.
- Cras justo odio
- Dapibus ac facilisis in
- Morbi leo risus
- Porta ac consectetur ac
- Vestibulum at eros
Active items
Just add .active
to a .list-group-item
to indicate the current active selection.
- Cras justo odio
- Dapibus ac facilisis in
- Morbi leo risus
- Porta ac consectetur ac
- Vestibulum at eros
Disabled items
You can add .disabled
to a .list-group-item
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).
- Cras justo odio
- Dapibus ac facilisis in
- Morbi leo risus
- Porta ac consectetur ac
- Vestibulum at eros
Flush
You can add .list-group-flush
to remove some borders and rounded corners to render list group
items edge-to-edge in a parent container (e.g., cards).
- Cras justo odio
- Dapibus ac facilisis in
- Morbi leo risus
- Porta ac consectetur ac
- Vestibulum at eros
Horizontal
Add .list-group-horizontal
to change the layout of list group items from vertical to horizontal across
all
breakpoints. Alternatively, choose a responsive variant .list-group-horizontal-{sm|md|lg|xl}
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.
- Cras justo odio
- Dapibus ac facilisis in
- Morbi leo risus
- Cras justo odio
- Dapibus ac facilisis in
- Morbi leo risus
- Cras justo odio
- Dapibus ac facilisis in
- Morbi leo risus
- Cras justo odio
- Dapibus ac facilisis in
- Morbi leo risus
- Cras justo odio
- Dapibus ac facilisis in
- Morbi leo risus
Contextual classes
Use contextual classes to style list items with a stateful background and color.
- Dapibus ac facilisis in
- A simple primary list group item
- A simple secondary list group item
- A simple success list group item
- A simple danger list group item
- A simple warning list group item
- A simple info list group item
- A simple light list group item
- A simple dark list group item
Contextual classes also work with .list-group-item-action
. 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
.sr-only
class.
With badges
Add badges to any list group item to show unread counts, activity, and more with the help of some utilities.
- Cras justo odio 14
- Dapibus ac facilisis in 2
- Morbi leo risus 1
Custom content
You may add nearly any HTML within, even for linked list groups like the one below, with the help of flexbox utilities.
List group item heading
3 days agoDonec id elit non mi porta gravida at eget metus. Maecenas sed diam eget risus varius blandit.
Donec id elit non mi porta.List group item heading
3 days agoDonec id elit non mi porta gravida at eget metus. Maecenas sed diam eget risus varius blandit.
Donec id elit non mi porta.List group item heading
3 days agoDonec id elit non mi porta gravida at eget metus. Maecenas sed diam eget risus varius blandit.
Donec id elit non mi porta.List with icons
Use icons to make your list group more creative and looks nice.
List icon with active items
- Cras justo odio
- Dapibus ac facilisis in
- Morbi leo risus
- Porta ac consectetur ac
- Vestibulum at eros
Social icon MDB Pro component
Icon list with square icons
Photos
Work
Vacation
List icons with rounded icons
Photos
Work
Vacation
JavaScript behavior
Use the tab JavaScript plugin—include it individually or through the compiled
bootstrap.js
file—to extend our list group to create tabbable panes of local content.
Using data attributes
You can activate a list group navigation without writing any JavaScript by simply specifying
data-toggle="list"
on an element. Use these data attributes on .list-group-item
.
Via JavaScript
Enable tabbable list items via JavaScript (each list item needs to be activated individually):
You can activate an individual list item in several ways:
Fade effect
To make tab panels fade in, add .fade
to each .tab-pane
. The first tab pane
must also have .show
to make the initial content visible.
Methods
$().tab
This activates a list item element and content container. Tab should have either a data-target
or an href
targeting a container node in the DOM.
.tab(‘show’)
This selects the given list item and shows its associated pane. Any other list item that was previously
selected becomes unselected and its associated pane is hidden. Returns to the caller before the tab pane
has actually been shown (for example, before the shown.bs.tab
event occurs).
Events
When showing a new tab, the events fire in the following order:
hide.bs.tab
(on the current active tab)show.bs.tab
(on the to-be-shown tab)hidden.bs.tab
(on the previously active tab, the same one as for thehide.bs.tab
event)shown.bs.tab
(on the newly-active just-shown tab, the same one as for theshow.bs.tab
event)
If no tab was already active, the hide.bs.tab
and hidden.bs.tab
events will
not be fired.
Event type | Description |
---|---|
show.bs.tab | This event fires on tab show, but before the new tab has been shown. Use event.target and
event.relatedTarget to target the active tab and the previously active tab (if available)
respectively. |
shown.bs.tab | This event fires on tab show after a tab has been shown. Use event.target and
event.relatedTarget
to target the active tab and the previously active tab (if available) respectively. |
hide.bs.tab | This event fires when a new tab is to be shown (and thus the previously active tab is to be hidden). Use
event.target and event.relatedTarget to target the currently active tab and the new
soon-to-be-active tab, respectively. |
hidden.bs.tab | This event fires after a new tab is shown (and thus the previously active tab is hidden). Use
event.target
and event.relatedTarget to target the previously active tab and the new active tab, respectively.
|