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
<ul class="list-group">
<li class="list-group-item">Cras justo odio</li>
<li class="list-group-item">Dapibus ac facilisis in</li>
<li class="list-group-item">Morbi leo risus</li>
<li class="list-group-item">Porta ac consectetur ac</li>
<li class="list-group-item">Vestibulum at eros</li>
</ul>
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
<ul class="list-group">
<li class="list-group-item active">Cras justo odio</li>
<li class="list-group-item">Dapibus ac facilisis in</li>
<li class="list-group-item">Morbi leo risus</li>
<li class="list-group-item">Porta ac consectetur ac</li>
<li class="list-group-item">Vestibulum at eros</li>
</ul>
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
<ul class="list-group">
<li class="list-group-item disabled">Cras justo odio</li>
<li class="list-group-item">Dapibus ac facilisis in</li>
<li class="list-group-item">Morbi leo risus</li>
<li class="list-group-item">Porta ac consectetur ac</li>
<li class="list-group-item">Vestibulum at eros</li>
</ul>
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
<ul class="list-group list-group-flush">
<li class="list-group-item">Cras justo odio</li>
<li class="list-group-item">Dapibus ac facilisis in</li>
<li class="list-group-item">Morbi leo risus</li>
<li class="list-group-item">Porta ac consectetur ac</li>
<li class="list-group-item">Vestibulum at eros</li>
</ul>
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
<ul class="list-group list-group-horizontal">
<li class="list-group-item">Cras justo odio</li>
<li class="list-group-item">Dapibus ac facilisis in</li>
<li class="list-group-item">Morbi leo risus</li>
</ul>
- Cras justo odio
- Dapibus ac facilisis in
- Morbi leo risus
<ul class="list-group list-group-horizontal-sm">
<li class="list-group-item">Cras justo odio</li>
<li class="list-group-item">Dapibus ac facilisis in</li>
<li class="list-group-item">Morbi leo risus</li>
</ul>
- Cras justo odio
- Dapibus ac facilisis in
- Morbi leo risus
<ul class="list-group list-group-horizontal-md">
<li class="list-group-item">Cras justo odio</li>
<li class="list-group-item">Dapibus ac facilisis in</li>
<li class="list-group-item">Morbi leo risus</li>
</ul>
- Cras justo odio
- Dapibus ac facilisis in
- Morbi leo risus
<ul class="list-group list-group-horizontal-lg">
<li class="list-group-item">Cras justo odio</li>
<li class="list-group-item">Dapibus ac facilisis in</li>
<li class="list-group-item">Morbi leo risus</li>
</ul>
- Cras justo odio
- Dapibus ac facilisis in
- Morbi leo risus
<ul class="list-group list-group-horizontal-xl">
<li class="list-group-item">Cras justo odio</li>
<li class="list-group-item">Dapibus ac facilisis in</li>
<li class="list-group-item">Morbi leo risus</li>
</ul>
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
<ul class="list-group">
<li class="list-group-item">Dapibus ac facilisis in</li>
<li class="list-group-item list-group-item-primary">A simple primary list group item</li>
<li class="list-group-item list-group-item-secondary">A simple secondary list group item</li>
<li class="list-group-item list-group-item-success">A simple success list group item</li>
<li class="list-group-item list-group-item-danger">A simple danger list group item</li>
<li class="list-group-item list-group-item-warning">A simple warning list group item</li>
<li class="list-group-item list-group-item-info">A simple info list group item</li>
<li class="list-group-item list-group-item-light">A simple light list group item</li>
<li class="list-group-item list-group-item-dark">A simple dark list group item</li>
</ul>
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.
<div class="list-group">
<a href="#!" class="list-group-item list-group-item-action">Dapibus ac facilisis in</a>
<a href="#!" class="list-group-item list-group-item-action list-group-item-primary">A simple primary list
group item</a>
<a href="#!" class="list-group-item list-group-item-action list-group-item-secondary">A simple secondary list
group item</a>
<a href="#!" class="list-group-item list-group-item-action list-group-item-success">A simple success list
group item</a>
<a href="#!" class="list-group-item list-group-item-action list-group-item-danger">A simple danger list group
item</a>
<a href="#!" class="list-group-item list-group-item-action list-group-item-warning">A simple warning list
group item</a>
<a href="#!" class="list-group-item list-group-item-action list-group-item-info">A simple info list group
item</a>
<a href="#!" class="list-group-item list-group-item-action list-group-item-light">A simple light list group
item</a>
<a href="#!" class="list-group-item list-group-item-action list-group-item-dark">A simple dark list group
item</a>
</div>
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
<ul class="list-group">
<li class="list-group-item d-flex justify-content-between align-items-center">
Cras justo odio
<span class="badge badge-primary badge-pill">14</span>
</li>
<li class="list-group-item d-flex justify-content-between align-items-center">
Dapibus ac facilisis in
<span class="badge badge-primary badge-pill">2</span>
</li>
<li class="list-group-item d-flex justify-content-between align-items-center">
Morbi leo risus
<span class="badge badge-primary badge-pill">1</span>
</li>
</ul>
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.
<div class="list-group">
<a href="#!" class="list-group-item list-group-item-action flex-column align-items-start active">
<div class="d-flex w-100 justify-content-between">
<h5 class="mb-2 h5">List group item heading</h5>
<small>3 days ago</small>
</div>
<p class="mb-2">Donec id elit non mi porta gravida at eget metus. Maecenas sed diam eget risus varius
blandit.</p>
<small>Donec id elit non mi porta.</small>
</a>
<a href="#!" class="list-group-item list-group-item-action flex-column align-items-start">
<div class="d-flex w-100 justify-content-between">
<h5 class="mb-2 h5">List group item heading</h5>
<small class="text-muted">3 days ago</small>
</div>
<p class="mb-2">Donec id elit non mi porta gravida at eget metus. Maecenas sed diam eget risus varius
blandit.</p>
<small class="text-muted">Donec id elit non mi porta.</small>
</a>
<a href="#!" class="list-group-item list-group-item-action flex-column align-items-start">
<div class="d-flex w-100 justify-content-between">
<h5 class="mb-2 h5">List group item heading</h5>
<small class="text-muted">3 days ago</small>
</div>
<p class="mb-2">Donec id elit non mi porta gravida at eget metus. Maecenas sed diam eget risus varius
blandit.</p>
<small class="text-muted">Donec id elit non mi porta.</small>
</a>
</div>
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
<ul class="list-group">
<li class="list-group-item active">
<div class="md-v-line"></div><i class="fas fa-laptop mr-4 pr-3"></i> Cras justo odio
</li>
<li class="list-group-item">
<div class="md-v-line"></div><i class="fas fa-bomb mr-5"></i>Dapibus ac facilisis in
</li>
<li class="list-group-item">
<div class="md-v-line"></div><i class="fas fa-code mr-5"></i>Morbi leo risus
</li>
<li class="list-group-item">
<div class="md-v-line"></div><i class="far fa-gem mr-5"></i>Porta ac consectetur ac
</li>
<li class="list-group-item">
<div class="md-v-line"></div><i class="fas fa-cogs mr-5"></i>Vestibulum at eros
</li>
</ul>
.md-v-line {
position: absolute;
border-left: 1px solid rgba(0,0,0,.125);
height: 50px;
top:0px;
left:54px;
}
Social icon MDB Pro component
<ul class="list-group list-group-flush">
<ul class="list-group">
<li class="list-group-item">
<a class="text-white btn-floating btn-fb btn-sm"><i class="fab fa-facebook-f"></i></a> Cras justo odio
</li>
<li class="list-group-item">
<a class="btn-floating btn-tw btn-sm"><i class="fab fa-twitter"></i></a>Dapibus ac facilisis in
</li>
<li class="list-group-item">
<a class="text-white btn-floating btn-li btn-sm"><i class="fab fa-linkedin-in"></i></a>Morbi leo risus
</li>
<li class="list-group-item">
<a class="text-white btn-floating btn-slack btn-sm"><i class="fab fa-slack-hash"></i></a>Porta ac
consectetur
ac
</li>
<li class="list-group-item">
<a class="text-white btn-floating btn-yt btn-sm"><i class="fab fa-youtube"></i></a>Vestibulum at eros
</li>
</ul>
</ul>
Icon list with square icons
Photos
Work
Vacation
<div class="list-group-flush">
<div class="list-group-item">
<p class="mb-0"><i class="fab fa-instagram fa-2x mr-4 blue p-3 white-text rounded " aria-hidden="true"></i>Photos</p>
</div>
<div class="list-group-item">
<p class="mb-0"> <i class="fab fa-slack-hash fa-2x mr-4 mr-4 red p-3 white-text rounded" aria-hidden="true"></i>Work</p>
</div>
<div class="list-group-item">
<p class="mb-0"><i class="fab fa-snapchat fa-2x mr-4 mr-4 purple p-3 white-text rounded" aria-hidden="true"></i>Vacation</p>
</div>
</div>
List icons with rounded icons
Photos
Work
Vacation
<div class="list-group-flush">
<div class="list-group-item">
<p class="mb-0"><i class="far fa-image fa-2x mr-4 grey p-3 white-text rounded-circle " aria-hidden="true"></i>Photos</p>
</div>
<div class="list-group-item">
<p class="mb-0"> <i class="fas fa-briefcase fa-2x mr-4 mr-4 grey p-3 white-text rounded-circle" aria-hidden="true"></i>Work</p>
</div>
<div class="list-group-item">
<p class="mb-0"><i class="fas fa-anchor fa-2x mr-4 mr-4 grey p-3 white-text rounded-circle" aria-hidden="true"></i>Vacation</p>
</div>
</div>
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.
<div class="row">
<div class="col-4">
<div class="list-group" id="list-tab" role="tablist">
<a class="list-group-item list-group-item-action active" id="list-home-list" data-toggle="list" href="#list-home"
role="tab" aria-controls="home">Home</a>
<a class="list-group-item list-group-item-action" id="list-profile-list" data-toggle="list" href="#list-profile"
role="tab" aria-controls="profile">Profile</a>
<a class="list-group-item list-group-item-action" id="list-messages-list" data-toggle="list" href="#list-messages"
role="tab" aria-controls="messages">Messages</a>
<a class="list-group-item list-group-item-action" id="list-settings-list" data-toggle="list" href="#list-settings"
role="tab" aria-controls="settings">Settings</a>
</div>
</div>
<div class="col-8">
<div class="tab-content" id="nav-tabContent">
<div class="tab-pane fade show active" id="list-home" role="tabpanel" aria-labelledby="list-home-list">
Velit aute mollit ipsum ad dolor consectetur nulla officia culpa adipisicing exercitation fugiat
tempor. Voluptate deserunt sit sunt nisi aliqua fugiat proident ea ut. Mollit voluptate reprehenderit
occaecat nisi ad non minim tempor sunt voluptate consectetur exercitation id ut nulla. Ea et fugiat
aliquip nostrud sunt incididunt consectetur culpa aliquip eiusmod dolor. Anim ad Lorem aliqua in
cupidatat nisi enim eu nostrud do aliquip veniam minim.
</div>
<div class="tab-pane fade" id="list-profile" role="tabpanel" aria-labelledby="list-profile-list">
Cupidatat quis ad sint excepteur laborum in esse qui. Et excepteur consectetur ex nisi eu do cillum ad
laborum. Mollit et eu officia dolore sunt Lorem culpa qui commodo velit ex amet id ex. Officia anim
incididunt laboris deserunt anim aute dolor incididunt veniam aute dolore do exercitation. Dolor nisi
culpa ex ad irure in elit eu dolore. Ad laboris ipsum reprehenderit irure non commodo enim culpa
commodo veniam incididunt veniam ad.
</div>
<div class="tab-pane fade" id="list-messages" role="tabpanel" aria-labelledby="list-messages-list">
Ut ut do pariatur aliquip aliqua aliquip exercitation do nostrud commodo reprehenderit aute ipsum
voluptate. Irure Lorem et laboris nostrud amet cupidatat cupidatat anim do ut velit mollit consequat
enim tempor. Consectetur est minim nostrud nostrud consectetur irure labore voluptate irure. Ipsum id
Lorem sit sint voluptate est pariatur eu ad cupidatat et deserunt culpa sit eiusmod deserunt.
Consectetur et fugiat anim do eiusmod aliquip nulla laborum elit adipisicing pariatur cillum.
</div>
<div class="tab-pane fade" id="list-settings" role="tabpanel" aria-labelledby="list-settings-list">
Irure enim occaecat labore sit qui aliquip reprehenderit amet velit. Deserunt ullamco ex elit nostrud
ut dolore nisi officia magna sit occaecat laboris sunt dolor. Nisi eu minim cillum occaecat aute est
cupidatat aliqua labore aute occaecat ea aliquip sunt amet. Aute mollit dolor ut exercitation irure
commodo non amet consectetur quis amet culpa. Quis ullamco nisi amet qui aute irure eu. Magna labore
dolor quis ex labore id nostrud deserunt dolor eiusmod eu pariatur culpa mollit in irure.
</div>
</div>
</div>
</div>
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
.
<!-- List group -->
<div class="list-group" id="myList" role="tablist">
<a class="list-group-item list-group-item-action active" data-toggle="list" href="#home" role="tab">Home</a>
<a class="list-group-item list-group-item-action" data-toggle="list" href="#profile" role="tab">Profile</a>
<a class="list-group-item list-group-item-action" data-toggle="list" href="#messages" role="tab">Messages</a>
<a class="list-group-item list-group-item-action" data-toggle="list" href="#settings" role="tab">Settings</a>
</div>
<!-- Tab panes -->
<div class="tab-content">
<div class="tab-pane active" id="home" role="tabpanel">
Velit aute mollit ipsum ad dolor consectetur nulla officia culpa adipisicing exercitation fugiat tempor.
Voluptate deserunt sit sunt nisi aliqua fugiat proident ea ut. Mollit voluptate reprehenderit occaecat nisi
ad non minim tempor sunt voluptate consectetur exercitation id ut nulla. Ea et fugiat aliquip nostrud sunt
incididunt consectetur culpa aliquip eiusmod dolor. Anim ad Lorem aliqua in cupidatat nisi enim eu nostrud
do aliquip veniam minim.
</div>
<div class="tab-pane" id="profile" role="tabpanel">
Cupidatat quis ad sint excepteur laborum in esse qui. Et excepteur consectetur ex nisi eu do cillum ad
laborum. Mollit et eu officia dolore sunt Lorem culpa qui commodo velit ex amet id ex. Officia anim
incididunt laboris deserunt anim aute dolor incididunt veniam aute dolore do exercitation. Dolor nisi culpa
ex ad irure in elit eu dolore. Ad laboris ipsum reprehenderit irure non commodo enim culpa commodo veniam
incididunt veniam ad.
</div>
<div class="tab-pane" id="messages" role="tabpanel">
Ut ut do pariatur aliquip aliqua aliquip exercitation do nostrud commodo reprehenderit aute ipsum
voluptate. Irure Lorem et laboris nostrud amet cupidatat cupidatat anim do ut velit mollit consequat enim
tempor. Consectetur est minim nostrud nostrud consectetur irure labore voluptate irure. Ipsum id Lorem sit
sint voluptate est pariatur eu ad cupidatat et deserunt culpa sit eiusmod deserunt. Consectetur et fugiat
anim do eiusmod aliquip nulla laborum elit adipisicing pariatur cillum.
</div>
<div class="tab-pane" id="settings" role="tabpanel">
Irure enim occaecat labore sit qui aliquip reprehenderit amet velit. Deserunt ullamco ex elit nostrud ut
dolore nisi officia magna sit occaecat laboris sunt dolor. Nisi eu minim cillum occaecat aute est cupidatat
aliqua labore aute occaecat ea aliquip sunt amet. Aute mollit dolor ut exercitation irure commodo non amet
consectetur quis amet culpa. Quis ullamco nisi amet qui aute irure eu. Magna labore dolor quis ex labore id
nostrud deserunt dolor eiusmod eu pariatur culpa mollit in irure.
</div>
</div>
Via JavaScript
Enable tabbable list items via JavaScript (each list item needs to be activated individually):
$('#myList a').on('click', function (e) {
e.preventDefault()
$(this).tab('show')
})
You can activate an individual list item in several ways:
$('#myList a[href="#profile"]').tab('show') // Select tab by name
$('#myList a:first-child').tab('show') // Select first tab
$('#myList a:last-child').tab('show') // Select last tab
$('#myList a:nth-child(3)').tab('show') // Select third tab
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.
<div class="tab-content">
<div class="tab-pane fade show active" id="home" role="tabpanel">...</div>
<div class="tab-pane fade" id="profile" role="tabpanel">...</div>
<div class="tab-pane fade" id="messages" role="tabpanel">...</div>
<div class="tab-pane fade" id="settings" role="tabpanel">...</div>
</div>
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.
<div class="list-group" id="myList" role="tablist">
<a class="list-group-item list-group-item-action active" data-toggle="list" href="#home" role="tab">Home</a>
<a class="list-group-item list-group-item-action" data-toggle="list" href="#profile" role="tab">Profile</a>
<a class="list-group-item list-group-item-action" data-toggle="list" href="#messages" role="tab">Messages</a>
<a class="list-group-item list-group-item-action" data-toggle="list" href="#settings" role="tab">Settings</a>
</div>
<div class="tab-content">
<div class="tab-pane active" id="home" role="tabpanel">...</div>
<div class="tab-pane" id="profile" role="tabpanel">...</div>
<div class="tab-pane" id="messages" role="tabpanel">...</div>
<div class="tab-pane" id="settings" role="tabpanel">...</div>
</div>
$(function () {
$('#myList a:last-child').tab('show')
})
.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).
$('#someListItem').tab('show')
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.
|
$('a[data-toggle="list"]').on('shown.bs.tab', function (e) {
e.target // newly activated tab
e.relatedTarget // previous active tab
})