mdb-ui-kit/docs/components/list-group.md
2016-03-17 17:25:31 -05:00

5.4 KiB

layout title group
docs List group components

[//]: # DO NOT EDIT IT WILL BE OVERWRITTEN - copy of bootstrap documentation generated by gulp docs:copy:bs-docs

{% callout info %} Bootstrap Reference Documentation This is a part of the reference documentation from Bootstrap. It is included here to demonstrate rendering with Material Design for Bootstrap default styling. See the Material Design section for more elements and customization options. {% endcallout %}

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

Tags

Add tags 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 %}

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