0
0
mirror of https://github.com/twbs/bootstrap.git synced 2024-12-02 14:24:19 +01:00
Bootstrap/docs/components/list-group.md
Starsam80 8d031090d0 Rename .flex-xs-* and .flex-items-xs-* to .flex-* and .flex-items-* (#21218)
* Clean up _flex.scss a little

This commit just cleans up the formating of _flex.scss by changing
it so that it uses a single `@include media-breakpoint-up` instead
of multiple. It also aligns all of the CSS properties so it looks
a bit nicer.

* Remove `-xs` from flex classes
2016-11-27 15:19:27 -08:00

5.9 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 not only simple lists of elements, but complex ones with custom content.

Contents

  • Will be replaced with the ToC, excluding the "Contents" header {:toc}

Basic example

The most basic list group is simply an unordered list with list items, and the proper classes. Build upon it with the options that follow, or your own CSS as needed.

{% example html %}

  • Cras justo odio
  • Dapibus ac facilisis in
  • Morbi leo risus
  • Porta ac consectetur ac
  • Vestibulum at eros
{% endexample %}

Badge

Add badges to any list group item to show unread counts, activity, etc.

{% example html %}

  • 14 Cras justo odio
  • 2 Dapibus ac facilisis in
  • 1 Morbi leo risus
{% endexample %}

When in flexbox mode, you'll need to rearrange the contents of your list group items. To replicate the right-aligned badges as shown above, use the following example's code. Note the [flex-items-between utility class]({{ site.baseurl }}/layout/flexbox-grid/#horizontal-alignment), the badge's placement, and the lack of a float utility on the badges.

{% highlight html %}

  • Cras justo odio 14
  • Dapibus ac facilisis in 2
  • Morbi leo risus 1
{% endhighlight %}

Disabled items

Add .disabled to a .list-group-item to gray it out to appear disabled.

{% example html %}

{% endexample %}

Anchors and buttons

Use anchors or buttons to create actionable list group items with hover, disabled, and active states by adding .list-group-item-action. This separate class contains a few overrides to add compatibility for <a>s and <button>s, as well as the hover and focus states.

Be sure to not use the standard .btn classes here.

{% example html %}

{% endexample %}

{% example html %}

Cras justo odio Dapibus ac facilisis in Morbi leo risus Porta ac consectetur ac Vestibulum at eros
{% endexample %}

Contextual classes

Use contextual classes to style list items, default or linked. Also includes .active state.

{% example html %}

{% endexample %}

{% capture callout-include %}{% include callout-warning-color-assistive-technologies.md %}{% endcapture %} {{ callout-include | markdownify }}

Custom content

Add nearly any HTML within, even for linked list groups like the one below.

{% example html %}

{% endexample %}