CoreUI Logo
Sneak Peek! CoreUI 3 is coming! Please try the latest version - CoreUI PRO 3.0.0-alpha.. Try CoreUI PRO 3.0.0-alpha

Bootstrap list group

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.

Basic example

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.

  • Quisque hendrerit orci
  • Maecenas dignissim iaculis
  • Aenean ligula neque
  • In rutrum ante tincidunt
  • Curabitur mollis suscipit quam
<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>

Active items

Attach .active to a .list-group-item to show the current active selection.

  • Quisque hendrerit orci
  • Maecenas dignissim iaculis
  • Aenean ligula neque
  • In rutrum ante tincidunt
  • Curabitur mollis suscipit quam
<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>

Disabled items

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

  • Quisque hendrerit orci
  • Maecenas dignissim iaculis
  • Aenean ligula neque
  • In rutrum ante tincidunt
  • Curabitur mollis suscipit quam
<ul class="list-group">
  <li class="list-group-item disabled">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.

Quisque hendrerit orci Maecenas dignissim iaculis Aenean ligula neque In rutrum ante tincidunt Curabitur mollis suscipit quam 
<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">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>

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

  • Quisque hendrerit orci
  • Maecenas dignissim iaculis
  • Aenean ligula neque
  • In rutrum ante tincidunt
  • Curabitur mollis suscipit quam
<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>

Contextual classes

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

  • Maecenas dignissim iaculis
  • 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">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 also work with .list-group-item-action.

Maecenas dignissim iaculis 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 
<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>
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.

List group with an accent

Attach .list-group-accent to remove some borders and rounded corners to render list group items edge-to-edge in a parent container (e.g., cards).

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

With badges

Append badges to any list group item to display unread counts, activity, and more with the help of bootstrap utilities.

  • Quisque hendrerit orci 14
  • Maecenas dignissim iaculis 2
  • Aenean ligula neque 1 
<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>

Custom content

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 ago

Donec 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 ago

Donec 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 ago

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 flex-column align-items-start 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 flex-column align-items-start">
    <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 flex-column align-items-start">
    <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>

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.

Curabitur eget arcu quam. Nullam blandit justo eu commodo mollis. Quisque hendrerit orci vitae ante faucibus molestie. Praesent maximus et dolor eu condimentum. Praesent egestas est eu sem scelerisque tempor. Curabitur posuere metus vitae risus ultricies fermentum. Nulla fermentum, elit ac maximus laoreet, arcu massa bibendum ipsum, ac feugiat tellus orci id erat. Pellentesque elit felis, vehicula et egestas nec, pulvinar quis magna. Morbi sit amet malesuada erat, a placerat ex.

Praesent imperdiet, nulla sit amet vehicula volutpat, dolor velit aliquet mauris, a placerat orci urna vitae tellus. In hac habitasse platea dictumst. Donec ut elit eu urna tristique pellentesque. Maecenas dignissim iaculis scelerisque. Aenean ligula neque, efficitur sed elementum id, posuere eget lectus. Sed tristique sollicitudin arcu at interdum. Donec eget gravida nisi, id mollis nibh. Aliquam id accumsan quam. Praesent at suscipit magna. Sed porttitor tincidunt congue. Fusce dignissim dapibus consectetur.

Suspendisse finibus ullamcorper metus, vel bibendum libero rhoncus a. Sed quam purus, imperdiet dapibus eleifend et, vulputate ac augue. Aenean eu faucibus urna, eget auctor orci. Curabitur mollis suscipit quam. Mauris sit amet velit eu mi vulputate eleifend. Ut vitae tortor scelerisque, fermentum dolor a, efficitur nunc. Aliquam aliquam molestie justo lobortis congue.

In rutrum ante tincidunt, venenatis lorem eget, tristique eros. Phasellus lacinia, lorem at elementum pulvinar, urna justo commodo ipsum, quis lacinia felis lectus at ligula. Phasellus volutpat tortor in dolor convallis, sit amet dignissim leo feugiat. Curabitur suscipit sit amet felis eu gravida. Aliquam eget ullamcorper erat, in condimentum dolor. Suspendisse at sem sed ligula tincidunt mattis. Aenean mattis, mauris non suscipit commodo, orci nulla fermentum nisi, id bibendum orci magna ac metus.

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

Using data attributes

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>

Via JavaScript

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

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.

<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

Activates a list item element and content container. The 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>

.tab(‘show’)

Selects the list item and shows its associated pane. Any another list item that was previously selected becomes unselected, and its associated pane is hidden.

$('#someListItem').tab('show')

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 would 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 previous 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 previous active tab (if available) respectively.
hide.bs.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.bs.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.bs.tab', function (e) {
  e.target // newly activated tab
  e.relatedTarget // previous active tab
})