6.7 KiB
| layout | title | description | group |
|---|---|---|---|
| docs | List group | Learn about Bootstrap's list group component for rendering series of related content. | components |
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.
Contents
- Will be replaced with the ToC, excluding the "Contents" header {:toc}
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.
{% example html %}
- Cras justo odio
- Dapibus ac facilisis in
- Morbi leo risus
- Porta ac consectetur ac
- Vestibulum at eros
Active items
Add .active to a .list-group-item to indicate the current active selection.
{% example html %}
- Cras justo odio
- Dapibus ac facilisis in
- Morbi leo risus
- Porta ac consectetur ac
- Vestibulum at eros
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).
{% example html %}
- Cras justo odio
- Dapibus ac facilisis in
- Morbi leo risus
- Porta ac consectetur ac
- Vestibulum at eros
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.
{% example html %}
{% endexample %}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.
{% example html %}
Contextual classes
Use contextual classes to style list items with a stateful background and color.
{% example html %}
- Dapibus ac facilisis in
- Dapibus ac facilisis in
- Cras sit amet nibh libero
- Porta ac consectetur ac
- Vestibulum at eros
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.
{% example html %}
{% capture callout-include %}{% include callout-warning-color-assistive-technologies.md %}{% endcapture %} {{ callout-include | markdownify }}
With badges
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.
{% example html %}
- Cras justo odio 14
- Dapibus ac facilisis in 2
- Morbi leo risus 1
Custom content
Add nearly any HTML within, even for linked list groups like the one below.
{% example html %}