mirror of
https://github.com/twbs/bootstrap.git
synced 2024-12-01 13:24:25 +01:00
ec8c251928
- revert back to display block for list items to prevent unwanted behaviors - fixes a handful of other linked issues (see main thread) - updates docs to include more utilities for the one example
170 lines
7.3 KiB
Markdown
170 lines
7.3 KiB
Markdown
---
|
|
layout: docs
|
|
title: List group
|
|
description: Learn about Bootstrap's list group component for rendering series of related content.
|
|
group: 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 %}
|
|
<ul class="list-group">
|
|
<li class="list-group-item">Cras justo odio</li>
|
|
<li class="list-group-item">Dapibus ac facilisis in</li>
|
|
<li class="list-group-item">Morbi leo risus</li>
|
|
<li class="list-group-item">Porta ac consectetur ac</li>
|
|
<li class="list-group-item">Vestibulum at eros</li>
|
|
</ul>
|
|
{% endexample %}
|
|
|
|
## Active items
|
|
|
|
Add `.active` to a `.list-group-item` to indicate the current active selection.
|
|
|
|
{% example html %}
|
|
<ul class="list-group">
|
|
<li class="list-group-item active">Cras justo odio</li>
|
|
<li class="list-group-item">Dapibus ac facilisis in</li>
|
|
<li class="list-group-item">Morbi leo risus</li>
|
|
<li class="list-group-item">Porta ac consectetur ac</li>
|
|
<li class="list-group-item">Vestibulum at eros</li>
|
|
</ul>
|
|
{% endexample %}
|
|
|
|
## 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 %}
|
|
<ul class="list-group">
|
|
<li class="list-group-item disabled">Cras justo odio</li>
|
|
<li class="list-group-item">Dapibus ac facilisis in</li>
|
|
<li class="list-group-item">Morbi leo risus</li>
|
|
<li class="list-group-item">Porta ac consectetur ac</li>
|
|
<li class="list-group-item">Vestibulum at eros</li>
|
|
</ul>
|
|
{% endexample %}
|
|
|
|
## 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 %}
|
|
<div class="list-group">
|
|
<a href="#" class="list-group-item active">
|
|
Cras justo odio
|
|
</a>
|
|
<a href="#" class="list-group-item list-group-item-action">Dapibus ac facilisis in</a>
|
|
<a href="#" class="list-group-item list-group-item-action">Morbi leo risus</a>
|
|
<a href="#" class="list-group-item list-group-item-action">Porta ac consectetur ac</a>
|
|
<a href="#" class="list-group-item list-group-item-action disabled">Vestibulum at eros</a>
|
|
</div>
|
|
{% 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 %}
|
|
<div class="list-group">
|
|
<button type="button" class="list-group-item list-group-item-action active">
|
|
Cras justo odio
|
|
</button>
|
|
<button type="button" class="list-group-item list-group-item-action">Dapibus ac facilisis in</button>
|
|
<button type="button" class="list-group-item list-group-item-action">Morbi leo risus</button>
|
|
<button type="button" class="list-group-item list-group-item-action">Porta ac consectetur ac</button>
|
|
<button type="button" class="list-group-item list-group-item-action" disabled>Vestibulum at eros</button>
|
|
</div>
|
|
{% endexample %}
|
|
|
|
## Contextual classes
|
|
|
|
Use contextual classes to style list items with a stateful background and color.
|
|
|
|
{% example html %}
|
|
<ul class="list-group">
|
|
<li class="list-group-item">Dapibus ac facilisis in</li>
|
|
<li class="list-group-item list-group-item-success">Dapibus ac facilisis in</li>
|
|
<li class="list-group-item list-group-item-info">Cras sit amet nibh libero</li>
|
|
<li class="list-group-item list-group-item-warning">Porta ac consectetur ac</li>
|
|
<li class="list-group-item list-group-item-danger">Vestibulum at eros</li>
|
|
</ul>
|
|
{% endexample %}
|
|
|
|
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 %}
|
|
<div class="list-group">
|
|
<a href="#" class="list-group-item list-group-item-action">Dapibus ac facilisis in</a>
|
|
<a href="#" class="list-group-item list-group-item-action list-group-item-success">Dapibus ac facilisis in</a>
|
|
<a href="#" class="list-group-item list-group-item-action list-group-item-info">Cras sit amet nibh libero</a>
|
|
<a href="#" class="list-group-item list-group-item-action list-group-item-warning">Porta ac consectetur ac</a>
|
|
<a href="#" class="list-group-item list-group-item-action list-group-item-danger">Vestibulum at eros</a>
|
|
</div>
|
|
{% endexample %}
|
|
|
|
{% 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]({{ site.baseurl }}/utilities/flexbox/).
|
|
|
|
{% example html %}
|
|
<ul class="list-group">
|
|
<li class="list-group-item d-flex justify-content-between align-items-center">
|
|
Cras justo odio
|
|
<span class="badge badge-default badge-pill">14</span>
|
|
</li>
|
|
<li class="list-group-item d-flex justify-content-between align-items-center">
|
|
Dapibus ac facilisis in
|
|
<span class="badge badge-default badge-pill">2</span>
|
|
</li>
|
|
<li class="list-group-item d-flex justify-content-between align-items-center">
|
|
Morbi leo risus
|
|
<span class="badge badge-default badge-pill">1</span>
|
|
</li>
|
|
</ul>
|
|
{% endexample %}
|
|
|
|
## Custom content
|
|
|
|
Add nearly any HTML within, even for linked list groups like the one below, with the help of [flexbox utilities]({{ site.baseurl }}/utilities/flexbox/).
|
|
|
|
{% example html %}
|
|
<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>
|
|
{% endexample %}
|