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">An item</li>
  3.   <li class="list-group-item">A second item</li>
  4.   <li class="list-group-item">A third item</li>
  5.   <li class="list-group-item">A fourth item</li>
  6.   <li class="list-group-item">And a fifth one</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" aria-current="true">An active item</li>
  3.   <li class="list-group-item">A second item</li>
  4.   <li class="list-group-item">A third item</li>
  5.   <li class="list-group-item">A fourth item</li>
  6.   <li class="list-group-item">And a fifth one</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">A disabled item</li>
  3.   <li class="list-group-item">A second item</li>
  4.   <li class="list-group-item">A third item</li>
  5.   <li class="list-group-item">A fourth item</li>
  6.   <li class="list-group-item">And a fifth one</li>
  7. </ul>

Links and buttons

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" aria-current="true">
  3.     The current link item
  4.   </a>
  5.   <a href="#" class="list-group-item list-group-item-action">A second link item</a>
  6.   <a href="#" class="list-group-item list-group-item-action">A third link item</a>
  7.   <a href="#" class="list-group-item list-group-item-action">A fourth link item</a>
  8.   <a href="#" class="list-group-item list-group-item-action disabled" tabindex="-1" aria-disabled="true">A disabled link item</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" aria-current="true">
  3.     The current button
  4.   </button>
  5.   <button type="button" class="list-group-item list-group-item-action">A second item</button>
  6.   <button type="button" class="list-group-item list-group-item-action">A third button item</button>
  7.   <button type="button" class="list-group-item list-group-item-action">A fourth button item</button>
  8.   <button type="button" class="list-group-item list-group-item-action" disabled>A disabled button item</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">An item</li>
  3.   <li class="list-group-item">A second item</li>
  4.   <li class="list-group-item">A third item</li>
  5.   <li class="list-group-item">A fourth item</li>
  6.   <li class="list-group-item">And a fifth one</li>
  7. </ul>

Numbered

Add the .list-group-numbered modifier class (and optionally use an <ol> element) 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 group items and to 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.

List group - 图7

  1. <ol class="list-group list-group-numbered">
  2.   <li class="list-group-item">Cras justo odio</li>
  3.   <li class="list-group-item">Cras justo odio</li>
  4.   <li class="list-group-item">Cras justo odio</li>
  5. </ol>

These work great with custom content as well.

List group - 图8

  1. <ol class="list-group list-group-numbered">
  2.   <li class="list-group-item d-flex justify-content-between align-items-start">
  3.     <div class="ms-2 me-auto">
  4.       <div class="fw-bold">Subheading</div>
  5.       Cras justo odio
  6.     </div>
  7.     <span class="badge bg-primary rounded-pill">14</span>
  8.   </li>
  9.   <li class="list-group-item d-flex justify-content-between align-items-start">
  10.     <div class="ms-2 me-auto">
  11.       <div class="fw-bold">Subheading</div>
  12.       Cras justo odio
  13.     </div>
  14.     <span class="badge bg-primary rounded-pill">14</span>
  15.   </li>
  16.   <li class="list-group-item d-flex justify-content-between align-items-start">
  17.     <div class="ms-2 me-auto">
  18.       <div class="fw-bold">Subheading</div>
  19.       Cras justo odio
  20.     </div>
  21.     <span class="badge bg-primary rounded-pill">14</span>
  22.   </li>
  23. </ol>

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

List group - 图9

  1. <ul class="list-group list-group-horizontal">
  2.   <li class="list-group-item">An item</li>
  3.   <li class="list-group-item">A second item</li>
  4.   <li class="list-group-item">A third item</li>
  5. </ul>
  6. <ul class="list-group list-group-horizontal-sm">
  7.   <li class="list-group-item">An item</li>
  8.   <li class="list-group-item">A second item</li>
  9.   <li class="list-group-item">A third item</li>
  10. </ul>
  11. <ul class="list-group list-group-horizontal-md">
  12.   <li class="list-group-item">An item</li>
  13.   <li class="list-group-item">A second item</li>
  14.   <li class="list-group-item">A third item</li>
  15. </ul>
  16. <ul class="list-group list-group-horizontal-lg">
  17.   <li class="list-group-item">An item</li>
  18.   <li class="list-group-item">A second item</li>
  19.   <li class="list-group-item">A third item</li>
  20. </ul>
  21. <ul class="list-group list-group-horizontal-xl">
  22.   <li class="list-group-item">An item</li>
  23.   <li class="list-group-item">A second item</li>
  24.   <li class="list-group-item">A third item</li>
  25. </ul>
  26. <ul class="list-group list-group-horizontal-xxl">
  27.   <li class="list-group-item">An item</li>
  28.   <li class="list-group-item">A second item</li>
  29.   <li class="list-group-item">A third item</li>
  30. </ul>

Contextual classes

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

List group - 图10

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

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

  1. <ul class="list-group">
  2.   <li class="list-group-item d-flex justify-content-between align-items-center">
  3.     A list item
  4.     <span class="badge bg-primary rounded-pill">14</span>
  5.   </li>
  6.   <li class="list-group-item d-flex justify-content-between align-items-center">
  7.     A second list item
  8.     <span class="badge bg-primary rounded-pill">2</span>
  9.   </li>
  10.   <li class="list-group-item d-flex justify-content-between align-items-center">
  11.     A third list item
  12.     <span class="badge bg-primary rounded-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 - 图13

  1. <div class="list-group">
  2.   <a href="#" class="list-group-item list-group-item-action active" aria-current="true">
  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">Some placeholder content in a paragraph.</p>
  8.     <small>And some small print.</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">Some placeholder content in a paragraph.</p>
  16.     <small class="text-muted">And some muted small print.</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">Some placeholder content in a paragraph.</p>
  24.     <small class="text-muted">And some muted small print.</small>
  25.   </a>
  26. </div>

Checkboxes and radios

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.

List group - 图14

  1. <ul class="list-group">
  2.   <li class="list-group-item">
  3.     <input class="form-check-input me-1" type="checkbox" value="" aria-label="...">
  4.     First checkbox
  5.   </li>
  6.   <li class="list-group-item">
  7.     <input class="form-check-input me-1" type="checkbox" value="" aria-label="...">
  8.     Second checkbox
  9.   </li>
  10.   <li class="list-group-item">
  11.     <input class="form-check-input me-1" type="checkbox" value="" aria-label="...">
  12.     Third checkbox
  13.   </li>
  14.   <li class="list-group-item">
  15.     <input class="form-check-input me-1" type="checkbox" value="" aria-label="...">
  16.     Fourth checkbox
  17.   </li>
  18.   <li class="list-group-item">
  19.     <input class="form-check-input me-1" type="checkbox" value="" aria-label="...">
  20.     Fifth checkbox
  21.   </li>
  22. </ul>

And if you want <label>s as the .list-group-item for large hit areas, you can do that, too.

List group - 图15

  1. <div class="list-group">
  2.   <label class="list-group-item">
  3.     <input class="form-check-input me-1" type="checkbox" value="">
  4.     First checkbox
  5.   </label>
  6.   <label class="list-group-item">
  7.     <input class="form-check-input me-1" type="checkbox" value="">
  8.     Second checkbox
  9.   </label>
  10.   <label class="list-group-item">
  11.     <input class="form-check-input me-1" type="checkbox" value="">
  12.     Third checkbox
  13.   </label>
  14.   <label class="list-group-item">
  15.     <input class="form-check-input me-1" type="checkbox" value="">
  16.     Fourth checkbox
  17.   </label>
  18.   <label class="list-group-item">
  19.     <input class="form-check-input me-1" type="checkbox" value="">
  20.     Fifth checkbox
  21.   </label>
  22. </div>

Sass

Variables

  1. $list-group-color:                  $gray-900;
  2. $list-group-bg:                     $white;
  3. $list-group-border-color:           rgba($black, .125);
  4. $list-group-border-width:           $border-width;
  5. $list-group-border-radius:          $border-radius;
  7. $list-group-item-padding-y:         $spacer / 2;
  8. $list-group-item-padding-x:         $spacer;
  9. $list-group-item-bg-scale:          -80%;
  10. $list-group-item-color-scale:       40%;
  12. $list-group-hover-bg:               $gray-100;
  13. $list-group-active-color:           $component-active-color;
  14. $list-group-active-bg:              $component-active-bg;
  15. $list-group-active-border-color:    $list-group-active-bg;
  17. $list-group-disabled-color:         $gray-600;
  18. $list-group-disabled-bg:            $list-group-bg;
  20. $list-group-action-color:           $gray-700;
  21. $list-group-action-hover-color:     $list-group-action-color;
  23. $list-group-action-active-color:    $body-color;
  24. $list-group-action-active-bg:       $gray-200;

Mixins

Used in combination with $theme-colors to generate the contextual variant classes for .list-group-items.

  1. @mixin list-group-item-variant($state, $background, $color) {
  2.   .list-group-item-#{$state} {
  3.     color: $color;
  4.     background-color: $background;
  6.     &.list-group-item-action {
  7.       &:hover,
  8.       &:focus {
  9.         color: $color;
  10.         background-color: shade-color($background, 10%);
  11.       }
  13.       &.active {
  14.         color: $white;
  15.         background-color: $color;
  16.         border-color: $color;
  17.       }
  18.     }
  19.   }
  20. }

Loop

Loop that generates the modifier classes with the list-group-item-variant() mixin.

  1. // List group contextual variants
  2. //
  3. // Add modifier classes to change text and background color on individual items.
  4. // Organizationally, this must come after the `:hover` states.
  6. @each $state, $value in $theme-colors {
  7.   $list-group-background: shift-color($value, $list-group-item-bg-scale);
  8.   $list-group-color: shift-color($value, $list-group-item-color-scale);
  9.   @if (contrast-ratio($list-group-background, $list-group-color) < $min-contrast-ratio) {
  10.     $list-group-color: mix($value, color-contrast($list-group-background), abs($list-group-item-color-scale));
  11.   }
  13.   @include list-group-item-variant($state, $list-group-background, $list-group-color);
  14. }

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-bs-toggle="list" href="#list-home" role="tab" aria-controls="list-home">Home</a>
  5.       <a class="list-group-item list-group-item-action" id="list-profile-list" data-bs-toggle="list" href="#list-profile" role="tab" aria-controls="list-profile">Profile</a>
  6.       <a class="list-group-item list-group-item-action" id="list-messages-list" data-bs-toggle="list" href="#list-messages" role="tab" aria-controls="list-messages">Messages</a>
  7.       <a class="list-group-item list-group-item-action" id="list-settings-list" data-bs-toggle="list" href="#list-settings" role="tab" aria-controls="list-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-bs-toggle="list" or on an element. Use these data attributes on .list-group-item.

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

Via JavaScript

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

  1. var triggerTabList = [].slice.call(document.querySelectorAll('#myTab a'))
  2. triggerTabList.forEach(function (triggerEl) {
  3.   var tabTrigger = new bootstrap.Tab(triggerEl)
  5.   triggerEl.addEventListener('click', function (event) {
  6.     event.preventDefault()
  7.     tabTrigger.show()
  8.   })
  9. })

You can activate individual list item in several ways:

  1. var triggerEl = document.querySelector('#myTab a[href="#profile"]')
  2. bootstrap.Tab.getInstance(triggerEl).show() // Select tab by name
  4. var triggerFirstTabEl = document.querySelector('#myTab li:first-child a')
  5. bootstrap.Tab.getInstance(triggerFirstTabEl).show() // Select first 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

constructor

Activates a list item element and content container. Tab should have either a data-bs-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-bs-toggle="list" href="#home" role="tab">Home</a>
  3.   <a class="list-group-item list-group-item-action" data-bs-toggle="list" href="#profile" role="tab">Profile</a>
  4.   <a class="list-group-item list-group-item-action" data-bs-toggle="list" href="#messages" role="tab">Messages</a>
  5.   <a class="list-group-item list-group-item-action" data-bs-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.   var firstTabEl = document.querySelector('#myTab a:last-child')
  17.   var firstTab = new bootstrap.Tab(firstTabEl)
  19.   firstTab.show()
  20. </script>

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.   var someListItemEl = document.querySelector('#someListItem')
  2.   var tab = new bootstrap.Tab(someListItemEl)
  4.   tab.show()

dispose

Destroys an element’s tab.

getInstance

Static method which allows you to get the tab instance associated with a DOM element

  1. var triggerEl = document.querySelector('#trigger')
  2. var tab = bootstrap.Tab.getInstance(triggerEl) // Returns a Bootstrap tab instance

Events

When showing a new tab, the events fire in the following order:

  1. hide.bs.tab (on the current active tab)
  2. show.bs.tab (on the to-be-shown tab)
  3. hidden.bs.tab (on the previous active tab, the same one as for the hide.bs.tab event)
  4. 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. var tabEl = document.querySelector('a[data-bs-toggle="list"]')
  2. tabEl.addEventListener('shown.bs.tab', function (event) {
  3.   event.target // newly activated tab
  4.   event.relatedTarget // previous active tab
  5. })