src/scss/bootstrap-4.0.0-alpha.6/docs/components/list-group.md

   1 ---
   2 layout: docs
   3 title: List group
   4 description: Learn about Bootstrap's list group component for rendering series of related content.
   5 group: components
   6 ---
   7
   8 List groups are a flexible and powerful component for displaying a series of content. List group items can be modified and extended to support just about any content within. They can also be used as navigation with the right modifier class.
   9
  10 ## Contents
  11
  12 * Will be replaced with the ToC, excluding the "Contents" header
  13 {:toc}
  14
  15 ## Basic example
  16 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.
  17
  18 {% example html %}
  19 <ul class="list-group">
  20   <li class="list-group-item">Cras justo odio</li>
  21   <li class="list-group-item">Dapibus ac facilisis in</li>
  22   <li class="list-group-item">Morbi leo risus</li>
  23   <li class="list-group-item">Porta ac consectetur ac</li>
  24   <li class="list-group-item">Vestibulum at eros</li>
  25 </ul>
  26 {% endexample %}
  27
  28 ## Active items
  29
  30 Add `.active` to a `.list-group-item` to indicate the current active selection.
  31
  32 {% example html %}
  33 <ul class="list-group">
  34   <li class="list-group-item active">Cras justo odio</li>
  35   <li class="list-group-item">Dapibus ac facilisis in</li>
  36   <li class="list-group-item">Morbi leo risus</li>
  37   <li class="list-group-item">Porta ac consectetur ac</li>
  38   <li class="list-group-item">Vestibulum at eros</li>
  39 </ul>
  40 {% endexample %}
  41
  42 ## Disabled items
  43
  44 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).
  45
  46 {% example html %}
  47 <ul class="list-group">
  48   <li class="list-group-item disabled">Cras justo odio</li>
  49   <li class="list-group-item">Dapibus ac facilisis in</li>
  50   <li class="list-group-item">Morbi leo risus</li>
  51   <li class="list-group-item">Porta ac consectetur ac</li>
  52   <li class="list-group-item">Vestibulum at eros</li>
  53 </ul>
  54 {% endexample %}
  55
  56 ## Links and buttons
  57
  58 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.
  59
  60 Be sure to **not use the standard `.btn` classes here**.
  61
  62 {% example html %}
  63 <div class="list-group">
  64   <a href="#" class="list-group-item active">
  65     Cras justo odio
  66   </a>
  67   <a href="#" class="list-group-item list-group-item-action">Dapibus ac facilisis in</a>
  68   <a href="#" class="list-group-item list-group-item-action">Morbi leo risus</a>
  69   <a href="#" class="list-group-item list-group-item-action">Porta ac consectetur ac</a>
  70   <a href="#" class="list-group-item list-group-item-action disabled">Vestibulum at eros</a>
  71 </div>
  72 {% endexample %}
  73
  74 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.
  75
  76 {% example html %}
  77 <div class="list-group">
  78   <button type="button" class="list-group-item list-group-item-action active">
  79     Cras justo odio
  80   </button>
  81   <button type="button" class="list-group-item list-group-item-action">Dapibus ac facilisis in</button>
  82   <button type="button" class="list-group-item list-group-item-action">Morbi leo risus</button>
  83   <button type="button" class="list-group-item list-group-item-action">Porta ac consectetur ac</button>
  84   <button type="button" class="list-group-item list-group-item-action" disabled>Vestibulum at eros</button>
  85 </div>
  86 {% endexample %}
  87
  88 ## Contextual classes
  89
  90 Use contextual classes to style list items with a stateful background and color.
  91
  92 {% example html %}
  93 <ul class="list-group">
  94   <li class="list-group-item">Dapibus ac facilisis in</li>
  95   <li class="list-group-item list-group-item-success">Dapibus ac facilisis in</li>
  96   <li class="list-group-item list-group-item-info">Cras sit amet nibh libero</li>
  97   <li class="list-group-item list-group-item-warning">Porta ac consectetur ac</li>
  98   <li class="list-group-item list-group-item-danger">Vestibulum at eros</li>
  99 </ul>
 100 {% endexample %}
 101
 102 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.
 103
 104 {% example html %}
 105 <div class="list-group">
 106   <a href="#" class="list-group-item list-group-item-action">Dapibus ac facilisis in</a>
 107   <a href="#" class="list-group-item list-group-item-action list-group-item-success">Dapibus ac facilisis in</a>
 108   <a href="#" class="list-group-item list-group-item-action list-group-item-info">Cras sit amet nibh libero</a>
 109   <a href="#" class="list-group-item list-group-item-action list-group-item-warning">Porta ac consectetur ac</a>
 110   <a href="#" class="list-group-item list-group-item-action list-group-item-danger">Vestibulum at eros</a>
 111 </div>
 112 {% endexample %}
 113
 114 {% capture callout-include %}{% include callout-warning-color-assistive-technologies.md %}{% endcapture %}
 115 {{ callout-include | markdownify }}
 116
 117 ## With badges
 118
 119 Add badges to any list group item to show unread counts, activity, and more with the help of some utilities. Note the [`justify-content-between` utility class]({{ site.baseurl }}/layout/grid/#horizontal-alignment) and the badge's placement.
 120
 121 {% example html %}
 122 <ul class="list-group">
 123   <li class="list-group-item justify-content-between">
 124     Cras justo odio
 125     <span class="badge badge-default badge-pill">14</span>
 126   </li>
 127   <li class="list-group-item justify-content-between">
 128     Dapibus ac facilisis in
 129     <span class="badge badge-default badge-pill">2</span>
 130   </li>
 131   <li class="list-group-item justify-content-between">
 132     Morbi leo risus
 133     <span class="badge badge-default badge-pill">1</span>
 134   </li>
 135 </ul>
 136 {% endexample %}
 137
 138 ## Custom content
 139
 140 Add nearly any HTML within, even for linked list groups like the one below, with the help of [flexbox utilities]({{ site.baseurl }}/utilities/flexbox/).
 141
 142 {% example html %}
 143 <div class="list-group">
 144   <a href="#" class="list-group-item list-group-item-action flex-column align-items-start active">
 145     <div class="d-flex w-100 justify-content-between">
 146       <h5 class="mb-1">List group item heading</h5>
 147       <small>3 days ago</small>
 148     </div>
 149     <p class="mb-1">Donec id elit non mi porta gravida at eget metus. Maecenas sed diam eget risus varius blandit.</p>
 150     <small>Donec id elit non mi porta.</small>
 151   </a>
 152   <a href="#" class="list-group-item list-group-item-action flex-column align-items-start">
 153     <div class="d-flex w-100 justify-content-between">
 154       <h5 class="mb-1">List group item heading</h5>
 155       <small class="text-muted">3 days ago</small>
 156     </div>
 157     <p class="mb-1">Donec id elit non mi porta gravida at eget metus. Maecenas sed diam eget risus varius blandit.</p>
 158     <small class="text-muted">Donec id elit non mi porta.</small>
 159   </a>
 160   <a href="#" class="list-group-item list-group-item-action flex-column align-items-start">
 161     <div class="d-flex w-100 justify-content-between">
 162       <h5 class="mb-1">List group item heading</h5>
 163       <small class="text-muted">3 days ago</small>
 164     </div>
 165     <p class="mb-1">Donec id elit non mi porta gravida at eget metus. Maecenas sed diam eget risus varius blandit.</p>
 166     <small class="text-muted">Donec id elit non mi porta.</small>
 167   </a>
 168 </div>
 169 {% endexample %}