List group

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.

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.

List group - 图1

  1. <ul class="list-group">
  2.   <li class="list-group-item">Cras justo odio</li>
  3.   <li class="list-group-item">Dapibus ac facilisis in</li>
  4.   <li class="list-group-item">Morbi leo risus</li>
  5.   <li class="list-group-item">Porta ac consectetur ac</li>
  6.   <li class="list-group-item">Vestibulum at eros</li>
  7. </ul>

Active items

Add .active to a .list-group-item to indicate the current active selection.

List group - 图2

  1. <ul class="list-group">
  2.   <li class="list-group-item active">Cras justo odio</li>
  3.   <li class="list-group-item">Dapibus ac facilisis in</li>
  4.   <li class="list-group-item">Morbi leo risus</li>
  5.   <li class="list-group-item">Porta ac consectetur ac</li>
  6.   <li class="list-group-item">Vestibulum at eros</li>
  7. </ul>

Disabled items

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).

List group - 图3

  1. <ul class="list-group">
  2.   <li class="list-group-item disabled" aria-disabled="true">Cras justo odio</li>
  3.   <li class="list-group-item">Dapibus ac facilisis in</li>
  4.   <li class="list-group-item">Morbi leo risus</li>
  5.   <li class="list-group-item">Porta ac consectetur ac</li>
  6.   <li class="list-group-item">Vestibulum at eros</li>
  7. </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.

List group - 图4

  1. <div class="list-group">
  2.   <a href="#" class="list-group-item list-group-item-action active">
  3.     Cras justo odio
  4.   </a>
  5.   <a href="#" class="list-group-item list-group-item-action">Dapibus ac facilisis in</a>
  6.   <a href="#" class="list-group-item list-group-item-action">Morbi leo risus</a>
  7.   <a href="#" class="list-group-item list-group-item-action">Porta ac consectetur ac</a>
  8.   <a href="#" class="list-group-item list-group-item-action disabled" tabindex="-1" aria-disabled="true">Vestibulum at eros</a>
  9. </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.

List group - 图5

  1. <div class="list-group">
  2.   <button type="button" class="list-group-item list-group-item-action active">
  3.     Cras justo odio
  4.   </button>
  5.   <button type="button" class="list-group-item list-group-item-action">Dapibus ac facilisis in</button>
  6.   <button type="button" class="list-group-item list-group-item-action">Morbi leo risus</button>
  7.   <button type="button" class="list-group-item list-group-item-action">Porta ac consectetur ac</button>
  8.   <button type="button" class="list-group-item list-group-item-action" disabled>Vestibulum at eros</button>
  9. </div>

Flush

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).

List group - 图6

  1. <ul class="list-group list-group-flush">
  2.   <li class="list-group-item">Cras justo odio</li>
  3.   <li class="list-group-item">Dapibus ac facilisis in</li>
  4.   <li class="list-group-item">Morbi leo risus</li>
  5.   <li class="list-group-item">Porta ac consectetur ac</li>
  6.   <li class="list-group-item">Vestibulum at eros</li>
  7. </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.

List group - 图7

  1. <ul class="list-group list-group-horizontal">
  2.   <li class="list-group-item">Cras justo odio</li>
  3.   <li class="list-group-item">Dapibus ac facilisis in</li>
  4.   <li class="list-group-item">Morbi leo risus</li>
  5. </ul>

List group - 图8

  1. <ul class="list-group list-group-horizontal-sm">
  2.   <li class="list-group-item">Cras justo odio</li>
  3.   <li class="list-group-item">Dapibus ac facilisis in</li>
  4.   <li class="list-group-item">Morbi leo risus</li>
  5. </ul>

List group - 图9

  1. <ul class="list-group list-group-horizontal-md">
  2.   <li class="list-group-item">Cras justo odio</li>
  3.   <li class="list-group-item">Dapibus ac facilisis in</li>
  4.   <li class="list-group-item">Morbi leo risus</li>
  5. </ul>

List group - 图10

  1. <ul class="list-group list-group-horizontal-lg">
  2.   <li class="list-group-item">Cras justo odio</li>
  3.   <li class="list-group-item">Dapibus ac facilisis in</li>
  4.   <li class="list-group-item">Morbi leo risus</li>
  5. </ul>

List group - 图11

  1. <ul class="list-group list-group-horizontal-xl">
  2.   <li class="list-group-item">Cras justo odio</li>
  3.   <li class="list-group-item">Dapibus ac facilisis in</li>
  4.   <li class="list-group-item">Morbi leo risus</li>
  5. </ul>

Contextual classes

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

List group - 图12

  1. <ul class="list-group">
  2.   <li class="list-group-item">Dapibus ac facilisis in</li>
  5.   <li class="list-group-item list-group-item-primary">A simple primary list group item</li>
  6.   <li class="list-group-item list-group-item-secondary">A simple secondary list group item</li>
  7.   <li class="list-group-item list-group-item-success">A simple success list group item</li>
  8.   <li class="list-group-item list-group-item-danger">A simple danger list group item</li>
  9.   <li class="list-group-item list-group-item-warning">A simple warning list group item</li>
  10.   <li class="list-group-item list-group-item-info">A simple info list group item</li>
  11.   <li class="list-group-item list-group-item-light">A simple light list group item</li>
  12.   <li class="list-group-item list-group-item-dark">A simple dark list group item</li>
  13. </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.

List group - 图13

  1. <div class="list-group">
  2.   <a href="#" class="list-group-item list-group-item-action">Dapibus ac facilisis in</a>
  5.   <a href="#" class="list-group-item list-group-item-action list-group-item-primary">A simple primary list group item</a>
  6.   <a href="#" class="list-group-item list-group-item-action list-group-item-secondary">A simple secondary list group item</a>
  7.   <a href="#" class="list-group-item list-group-item-action list-group-item-success">A simple success list group item</a>
  8.   <a href="#" class="list-group-item list-group-item-action list-group-item-danger">A simple danger list group item</a>
  9.   <a href="#" class="list-group-item list-group-item-action list-group-item-warning">A simple warning list group item</a>
  10.   <a href="#" class="list-group-item list-group-item-action list-group-item-info">A simple info list group item</a>
  11.   <a href="#" class="list-group-item list-group-item-action list-group-item-light">A simple light list group item</a>
  12.   <a href="#" class="list-group-item list-group-item-action list-group-item-dark">A simple dark list group item</a>
  13. </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.

List group - 图14

  1. <ul class="list-group">
  2.   <li class="list-group-item d-flex justify-content-between align-items-center">
  3.     Cras justo odio
  4.     <span class="badge badge-primary badge-pill">14</span>
  5.   </li>
  6.   <li class="list-group-item d-flex justify-content-between align-items-center">
  7.     Dapibus ac facilisis in
  8.     <span class="badge badge-primary badge-pill">2</span>
  9.   </li>
  10.   <li class="list-group-item d-flex justify-content-between align-items-center">
  11.     Morbi leo risus
  12.     <span class="badge badge-primary badge-pill">1</span>
  13.   </li>
  14. </ul>

Custom content

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

List group - 图15

  1. <div class="list-group">
  2.   <a href="#" class="list-group-item list-group-item-action active">
  3.     <div class="d-flex w-100 justify-content-between">
  4.       <h5 class="mb-1">List group item heading</h5>
  5.       <small>3 days ago</small>
  6.     </div>
  7.     <p class="mb-1">Donec id elit non mi porta gravida at eget metus. Maecenas sed diam eget risus varius blandit.</p>
  8.     <small>Donec id elit non mi porta.</small>
  9.   </a>
  10.   <a href="#" class="list-group-item list-group-item-action">
  11.     <div class="d-flex w-100 justify-content-between">
  12.       <h5 class="mb-1">List group item heading</h5>
  13.       <small class="text-muted">3 days ago</small>
  14.     </div>
  15.     <p class="mb-1">Donec id elit non mi porta gravida at eget metus. Maecenas sed diam eget risus varius blandit.</p>
  16.     <small class="text-muted">Donec id elit non mi porta.</small>
  17.   </a>
  18.   <a href="#" class="list-group-item list-group-item-action">
  19.     <div class="d-flex w-100 justify-content-between">
  20.       <h5 class="mb-1">List group item heading</h5>
  21.       <small class="text-muted">3 days ago</small>
  22.     </div>
  23.     <p class="mb-1">Donec id elit non mi porta gravida at eget metus. Maecenas sed diam eget risus varius blandit.</p>
  24.     <small class="text-muted">Donec id elit non mi porta.</small>
  25.   </a>
  26. </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.

List group - 图16

  1. <div class="row">
  2.   <div class="col-4">
  3.     <div class="list-group" id="list-tab" role="tablist">
  4.       <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>
  5.       <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>
  6.       <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>
  7.       <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>
  8.     </div>
  9.   </div>
  10.   <div class="col-8">
  11.     <div class="tab-content" id="nav-tabContent">
  12.       <div class="tab-pane fade show active" id="list-home" role="tabpanel" aria-labelledby="list-home-list">...</div>
  13.       <div class="tab-pane fade" id="list-profile" role="tabpanel" aria-labelledby="list-profile-list">...</div>
  14.       <div class="tab-pane fade" id="list-messages" role="tabpanel" aria-labelledby="list-messages-list">...</div>
  15.       <div class="tab-pane fade" id="list-settings" role="tabpanel" aria-labelledby="list-settings-list">...</div>
  16.     </div>
  17.   </div>
  18. </div>

Using data attributes

You can activate a list group navigation without writing any JavaScript by simply specifying data-toggle="list" or on an element. Use these data attributes on .list-group-item.

  1. <!-- List group -->
  2. <div class="list-group" id="myList" role="tablist">
  3.   <a class="list-group-item list-group-item-action active" data-toggle="list" href="#home" role="tab">Home</a>
  4.   <a class="list-group-item list-group-item-action" data-toggle="list" href="#profile" role="tab">Profile</a>
  5.   <a class="list-group-item list-group-item-action" data-toggle="list" href="#messages" role="tab">Messages</a>
  6.   <a class="list-group-item list-group-item-action" data-toggle="list" href="#settings" role="tab">Settings</a>
  7. </div>
  9. <!-- Tab panes -->
  10. <div class="tab-content">
  11.   <div class="tab-pane active" id="home" role="tabpanel">...</div>
  12.   <div class="tab-pane" id="profile" role="tabpanel">...</div>
  13.   <div class="tab-pane" id="messages" role="tabpanel">...</div>
  14.   <div class="tab-pane" id="settings" role="tabpanel">...</div>
  15. </div>

Via JavaScript

Enable tabbable list item via JavaScript (each list item needs to be activated individually):

  1. $('#myList a').on('click', function (e) {
  2.   e.preventDefault()
  3.   $(this).tab('show')
  4. })

You can activate individual list item in several ways:

  1. $('#myList a[href="#profile"]').tab('show') // Select tab by name
  2. $('#myList a:first-child').tab('show') // Select first tab
  3. $('#myList a:last-child').tab('show') // Select last tab
  4. $('#myList a:nth-child(3)').tab('show') // Select third tab

Fade effect

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.

  1. <div class="tab-content">
  2.   <div class="tab-pane fade show active" id="home" role="tabpanel">...</div>
  3.   <div class="tab-pane fade" id="profile" role="tabpanel">...</div>
  4.   <div class="tab-pane fade" id="messages" role="tabpanel">...</div>
  5.   <div class="tab-pane fade" id="settings" role="tabpanel">...</div>
  6. </div>

Methods

$().tab

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.

  1. <div class="list-group" id="myList" role="tablist">
  2.   <a class="list-group-item list-group-item-action active" data-toggle="list" href="#home" role="tab">Home</a>
  3.   <a class="list-group-item list-group-item-action" data-toggle="list" href="#profile" role="tab">Profile</a>
  4.   <a class="list-group-item list-group-item-action" data-toggle="list" href="#messages" role="tab">Messages</a>
  5.   <a class="list-group-item list-group-item-action" data-toggle="list" href="#settings" role="tab">Settings</a>
  6. </div>
  8. <div class="tab-content">
  9.   <div class="tab-pane active" id="home" role="tabpanel">...</div>
  10.   <div class="tab-pane" id="profile" role="tabpanel">...</div>
  11.   <div class="tab-pane" id="messages" role="tabpanel">...</div>
  12.   <div class="tab-pane" id="settings" role="tabpanel">...</div>
  13. </div>
  15. <script>
  16.   $(function () {
  17.     $('#myList a:last-child').tab('show')
  18.   })
  19. </script>

.tab(‘show’)

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).

  1. $('#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 previous active tab, the same one as for the hide.bs.tab event)
  • shown.bs.tab (on the newly-active just-shown tab, the same one as for the show.bs.tab event)
    If no tab was already active, the hide.bs.tab and hidden.bs.tab events will not be fired.
Event typeDescription
show.bs.tabThis 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.bs.tabThis 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.bs.tabThis 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.bs.tabThis 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.
  1. $('a[data-toggle="list"]').on('shown.bs.tab', function (e) {
  2.   e.target // newly activated tab
  3.   e.relatedTarget // previous active tab
  4. })