Bootstrap List Groups allows displaying are a series of content. Learn how to use Bootstrap list group to build complex list structure on your website.
On this page:The default list group is an unordered list with items and the proper CSS classes. Build upon it with the options that follow, or with your CSS as required.
<ul class="list-group">
<li class="list-group-item">Quisque hendrerit orci</li>
<li class="list-group-item">Maecenas dignissim iaculis</li>
<li class="list-group-item">Aenean ligula neque</li>
<li class="list-group-item">In rutrum ante tincidunt</li>
<li class="list-group-item">Curabitur mollis suscipit quam</li>
</ul>
Attach .active
to a .list-group-item
to show the current active selection.
<ul class="list-group">
<li class="list-group-item active">Quisque hendrerit orci</li>
<li class="list-group-item">Maecenas dignissim iaculis</li>
<li class="list-group-item">Aenean ligula neque</li>
<li class="list-group-item">In rutrum ante tincidunt</li>
<li class="list-group-item">Curabitur mollis suscipit quam</li>
</ul>
Attach .disabled
to a .list-group-item
to make it appear disabled. Remark that some of the elements with .disabled
will also require custom JavaScript to disable their click events (e.g., links).
<ul class="list-group">
<li class="list-group-item disabled" aria-disabled="true">Quisque hendrerit orci</li>
<li class="list-group-item">Maecenas dignissim iaculis</li>
<li class="list-group-item">Aenean ligula neque</li>
<li class="list-group-item">In rutrum ante tincidunt</li>
<li class="list-group-item">Curabitur mollis suscipit quam</li>
</ul>
Use <a>
s or <button>
s to create actionable list group items with hover, disabled, and active states by adding .list-group-item-action
. 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.
<div class="list-group">
<a href="#" class="list-group-item list-group-item-action active">
Quisque hendrerit orci
</a>
<a href="#" class="list-group-item list-group-item-action">Maecenas dignissim iaculis</a>
<a href="#" class="list-group-item list-group-item-action">Aenean ligula neque</a>
<a href="#" class="list-group-item list-group-item-action">In rutrum ante tincidunt</a>
<a href="#" class="list-group-item list-group-item-action disabled" tabindex="-1" aria-disabled="true">Curabitur mollis suscipit quam</a>
</div>
With <button>
s, you can also make use of the disabled
attribute instead of the .disabled
class. Sadly, <a>
s don’t support the disabled attribute.
<div class="list-group">
<button type="button" class="list-group-item list-group-item-action active">
Quisque hendrerit orci
</button>
<button type="button" class="list-group-item list-group-item-action">Maecenas dignissim iaculis</button>
<button type="button" class="list-group-item list-group-item-action">Aenean ligula neque</button>
<button type="button" class="list-group-item list-group-item-action">In rutrum ante tincidunt</button>
<button type="button" class="list-group-item list-group-item-action" disabled>Curabitur mollis suscipit quam</button>
</div>
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).
<ul class="list-group list-group-flush">
<li class="list-group-item">Quisque hendrerit orci</li>
<li class="list-group-item">Maecenas dignissim iaculis</li>
<li class="list-group-item">Aenean ligula neque</li>
<li class="list-group-item">In rutrum ante tincidunt</li>
<li class="list-group-item">Curabitur mollis suscipit quam</li>
</ul>
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.
Use contextual classes to style list items with a stateful background and color.
<ul class="list-group">
<li class="list-group-item">Maecenas dignissim iaculis</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 work with .list-group-item-action
.
<div class="list-group">
<a href="#" class="list-group-item list-group-item-action">Maecenas dignissim iaculis</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>
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.
Attach .clist-group-accent
to remove some borders and rounded corners to render list group items edge-to-edge in a parent container (e.g., cards).
<div class="list-group list-group-accent">
<div class="list-group-item list-group-item-accent-primary">A simple primary list group item</div>
<div class="list-group-item list-group-item-accent-secondary">A simple secondary list group item</div>
<div class="list-group-item list-group-item-accent-success">A simple success list group item</div>
<div class="list-group-item list-group-item-accent-danger">A simple danger list group item</div>
<div class="list-group-item list-group-item-accent-warning">A simple warning list group item</div>
<div class="list-group-item list-group-item-accent-info">A simple info list group item</div>
<div class="list-group-item list-group-item-accent-light">A simple light list group item</div>
<div class="list-group-item list-group-item-accent-dark">A simple dark list group item</div>
</div>
<div class="list-group list-group-accent">
<div class="list-group-item list-group-item-accent-primary list-group-item-primary">A simple primary list group item</div>
<div class="list-group-item list-group-item-accent-secondary list-group-item-secondary">A simple secondary list group item</div>
<div class="list-group-item list-group-item-accent-success list-group-item-success">A simple success list group item</div>
<div class="list-group-item list-group-item-accent-danger list-group-item-danger">A simple danger list group item</div>
<div class="list-group-item list-group-item-accent-warning list-group-item-warning">A simple warning list group item</div>
<div class="list-group-item list-group-item-accent-info list-group-item-info">A simple info list group item</div>
<div class="list-group-item list-group-item-accent-light list-group-item-light">A simple light list group item</div>
<div class="list-group-item list-group-item-accent-dark list-group-item-dark">A simple dark list group item</div>
</div>
Append badges to any list group item to display unread counts, activity, and more with the help of bootstrap utilities.
<ul class="list-group">
<li class="list-group-item d-flex justify-content-between align-items-center">
Quisque hendrerit orci
<span class="badge badge-primary badge-pill">14</span>
</li>
<li class="list-group-item d-flex justify-content-between align-items-center">
Maecenas dignissim iaculis
<span class="badge badge-primary badge-pill">2</span>
</li>
<li class="list-group-item d-flex justify-content-between align-items-center">
Aenean ligula neque
<span class="badge badge-primary badge-pill">1</span>
</li>
</ul>
Add nearly any HTML within, even for linked list groups like the one below, with the help of flexbox utilities.
Donec id elit non mi porta gravida at eget metus. Maecenas sed diam eget risus varius blandit.
Donec id elit non mi porta.Donec id elit non mi porta gravida at eget metus. Maecenas sed diam eget risus varius blandit.
Donec id elit non mi porta.Donec 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 active">
<div class="d-flex w-100 justify-content-between">
<h5 class="mb-1">List group item heading</h5>
<small>3 days ago</small>
</div>
<p class="mb-1">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">
<div class="d-flex w-100 justify-content-between">
<h5 class="mb-1">List group item heading</h5>
<small class="text-muted">3 days ago</small>
</div>
<p class="mb-1">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">
<div class="d-flex w-100 justify-content-between">
<h5 class="mb-1">List group item heading</h5>
<small class="text-muted">3 days ago</small>
</div>
<p class="mb-1">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>
You can activate a list group navigation without writing any JavaScript by merely specifying data-toggle="list"
or 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">...</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>
Enable tabbable list item via JavaScript (each list item needs to be activated individually):
var triggerTabList = [].slice.call(document.querySelectorAll('#myTab a'))
triggerTabList.forEach(function (triggerEl) {
var tabTrigger = new coreui.Tab(triggerEl)
triggerEl.addEventListener('click', function (e) {
e.preventDefault()
tabTrigger.show()
})
})
In version 3.x we removed jQuery in favor of regular JavaScript. CoreUI Library (@coreui/coreui) doesn’t need jQuery anymore. However, if you prefer to use jQuery over regular JavaScript, there is nothing to prevent.
Enable tabbable list item via JavaScript (each list item needs to be activated individually):
$('#myList a').on('click', function (e) {
e.preventDefault()
$(this).tab('show')
})
You can activate 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
To make tabs panel 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>
Use the tab JavaScript plugin—include it individually or through the compiled coreui.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">...</div>
<div class="tab-pane fade" id="list-profile" role="tabpanel" aria-labelledby="list-profile-list">...</div>
<div class="tab-pane fade" id="list-messages" role="tabpanel" aria-labelledby="list-messages-list">...</div>
<div class="tab-pane fade" id="list-settings" role="tabpanel" aria-labelledby="list-settings-list">...</div>
</div>
</div>
</div>
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>
<script>
var firstTabEl = document.querySelector('#myTab a:last-child')
var firstTab = new coreui.Tab(firstTabEl)
firstTab.show()
</script>
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.coreui.tab
event occurs).
var someListItemEl = document.querySelector('#someListItem')
var tab = new coreui.Tab(someListItemEl)
tab.show()
Destroys an element’s tab.
Static method which allows you to get the tab instance associated with a DOM element
var triggerEl = document.querySelector('#trigger')
var tab = coreui.Tab.getInstance(triggerEl) // Returns a Bootstrap tab instance
When showing a new tab, the events fire in the following order:
hide.coreui.tab
(on the current active tab)show.coreui.tab
(on the to-be-shown tab)hidden.coreui.tab
(on the previous active tab, the same one as for the hide.coreui.tab
event)shown.coreui.tab
(on the newly-active just-shown tab, the same one as for the show.coreui.tab
event)If no tab was already active, the hide.coreui.tab
and hidden.coreui.tab
events will not be fired.
Event type | Description |
---|---|
show.coreui.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 previous active tab (if available) respectively. |
shown.coreui.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 previous active tab (if available) respectively. |
hide.coreui.tab | This event fires when a new tab is to be shown (and thus the previous active tab is to be hidden). Use event.target and event.relatedTarget to target the current active tab and the new soon-to-be-active tab, respectively. |
hidden.coreui.tab | This event fires after a new tab is shown (and thus the previous active tab is hidden). Use event.target and event.relatedTarget to target the previous active tab and the new active tab, respectively. |
var tabEl = document.querySelector('a[data-toggle="list"]')
tabEl.addEventListener('shown.coreui.tab', function (e) {
e.target // newly activated tab
e.relatedTarget // previous active tab
})
In version 3.x we removed jQuery in favor of regular JavaScript. CoreUI Library (@coreui/coreui) doesn’t need jQuery anymore. However, if you prefer to use jQuery over regular JavaScript, there is nothing to prevent.
Use the tab JavaScript plugin—include it individually or through the compiled coreui.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">...</div>
<div class="tab-pane fade" id="list-profile" role="tabpanel" aria-labelledby="list-profile-list">...</div>
<div class="tab-pane fade" id="list-messages" role="tabpanel" aria-labelledby="list-messages-list">...</div>
<div class="tab-pane fade" id="list-settings" role="tabpanel" aria-labelledby="list-settings-list">...</div>
</div>
</div>
</div>
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>
<script>
$(function () {
$('#myList a:last-child').tab('show')
})
</script>
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.coreui.tab
event occurs).
$('#someListItem').tab('show')
When showing a new tab, the events fire in the following order:
hide.coreui.tab
(on the current active tab)show.coreui.tab
(on the to-be-shown tab)hidden.coreui.tab
(on the previous active tab, the same one as for the hide.coreui.tab
event)shown.coreui.tab
(on the newly-active just-shown tab, the same one as for the show.coreui.tab
event)If no tab was already active, the hide.coreui.tab
and hidden.coreui.tab
events will not be fired.
Event type | Description |
---|---|
show.coreui.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 previous active tab (if available) respectively. |
shown.coreui.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 previous active tab (if available) respectively. |
hide.coreui.tab | This event fires when a new tab is to be shown (and thus the previous active tab is to be hidden). Use event.target and event.relatedTarget to target the current active tab and the new soon-to-be-active tab, respectively. |
hidden.coreui.tab | This event fires after a new tab is shown (and thus the previous active tab is hidden). Use event.target and event.relatedTarget to target the previous active tab and the new active tab, respectively. |
$('a[data-toggle="list"]').on('shown.coreui.tab', function (e) {
e.target // newly activated tab
e.relatedTarget // previous active tab
})