list-group.md 4.78 KB
Newer Older
Mark Otto's avatar
Mark Otto committed
1
---
Mark Otto's avatar
Mark Otto committed
2
layout: docs
Mark Otto's avatar
Mark Otto committed
3
title: List group
4
group: components
Mark Otto's avatar
Mark Otto committed
5
6
---

Mark Otto's avatar
Mark Otto committed
7
8
List groups are a flexible and powerful component for displaying not only simple lists of elements, but complex ones with custom content.

Mark Otto's avatar
Mark Otto committed
9
10
11
12
13
14
## Contents

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

## Basic example
15
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.
Mark Otto's avatar
Mark Otto committed
16
17

{% example html %}
Mark Otto's avatar
Mark Otto committed
18
19
20
21
22
23
24
<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>
Mark Otto's avatar
Mark Otto committed
25
26
{% endexample %}

27
## Tags
Mark Otto's avatar
Mark Otto committed
28

29
Add tags to any list group item to show unread counts, activity, etc.
Mark Otto's avatar
Mark Otto committed
30
31

{% example html %}
Mark Otto's avatar
Mark Otto committed
32
33
<ul class="list-group">
  <li class="list-group-item">
34
    <span class="tag tag-default tag-pill pull-xs-right">14</span>
Mark Otto's avatar
Mark Otto committed
35
36
    Cras justo odio
  </li>
Mark Otto's avatar
Mark Otto committed
37
  <li class="list-group-item">
38
    <span class="tag tag-default tag-pill pull-xs-right">2</span>
Mark Otto's avatar
Mark Otto committed
39
40
41
    Dapibus ac facilisis in
  </li>
  <li class="list-group-item">
42
    <span class="tag tag-default tag-pill pull-xs-right">1</span>
Mark Otto's avatar
Mark Otto committed
43
44
    Morbi leo risus
  </li>
Mark Otto's avatar
Mark Otto committed
45
</ul>
Mark Otto's avatar
Mark Otto committed
46
47
{% endexample %}

48
## Disabled items
Mark Otto's avatar
Mark Otto committed
49

50
Add `.disabled` to a `.list-group-item` to gray it out to appear disabled.
Mark Otto's avatar
Mark Otto committed
51
52

{% example html %}
Mark Otto's avatar
Mark Otto committed
53
<div class="list-group">
54
  <a href="#" class="list-group-item disabled">
Mark Otto's avatar
Mark Otto committed
55
56
57
58
59
60
61
    Cras justo odio
  </a>
  <a href="#" class="list-group-item">Dapibus ac facilisis in</a>
  <a href="#" class="list-group-item">Morbi leo risus</a>
  <a href="#" class="list-group-item">Porta ac consectetur ac</a>
  <a href="#" class="list-group-item">Vestibulum at eros</a>
</div>
Mark Otto's avatar
Mark Otto committed
62
63
{% endexample %}

64
65
66
## 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.
Mark Otto's avatar
Mark Otto committed
67

68
Be sure to **not use the standard `.btn` classes here**.
Mark Otto's avatar
Mark Otto committed
69
70
71

{% example html %}
<div class="list-group">
72
73
74
75
76
77
78
  <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>
Mark Otto's avatar
Mark Otto committed
79
80
81
</div>
{% endexample %}

Mark Otto's avatar
Mark Otto committed
82
{% example html %}
Mark Otto's avatar
Mark Otto committed
83
<div class="list-group">
84
  <button type="button" class="list-group-item list-group-item-action active">
Mark Otto's avatar
Mark Otto committed
85
    Cras justo odio
86
87
88
89
90
  </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>
Mark Otto's avatar
Mark Otto committed
91
</div>
Mark Otto's avatar
Mark Otto committed
92
93
{% endexample %}

Mark Otto's avatar
Mark Otto committed
94
## Contextual classes
Mark Otto's avatar
Mark Otto committed
95
96
97
98

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

{% example html %}
Mark Otto's avatar
Mark Otto committed
99
<div class="list-group">
100
101
102
103
  <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>
Mark Otto's avatar
Mark Otto committed
104
</div>
Mark Otto's avatar
Mark Otto committed
105
106
{% endexample %}

Mark Otto's avatar
Mark Otto committed
107
## Custom content
Mark Otto's avatar
Mark Otto committed
108
109
110
111

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

{% example html %}
Mark Otto's avatar
Mark Otto committed
112
<div class="list-group">
113
114
  <a href="#" class="list-group-item list-group-item-action active">
    <h5 class="list-group-item-heading">List group item heading</h5>
Mark Otto's avatar
Mark Otto committed
115
116
    <p class="list-group-item-text">Donec id elit non mi porta gravida at eget metus. Maecenas sed diam eget risus varius blandit.</p>
  </a>
117
118
  <a href="#" class="list-group-item list-group-item-action">
    <h5 class="list-group-item-heading">List group item heading</h5>
Mark Otto's avatar
Mark Otto committed
119
120
    <p class="list-group-item-text">Donec id elit non mi porta gravida at eget metus. Maecenas sed diam eget risus varius blandit.</p>
  </a>
121
122
  <a href="#" class="list-group-item list-group-item-action">
    <h5 class="list-group-item-heading">List group item heading</h5>
Mark Otto's avatar
Mark Otto committed
123
    <p class="list-group-item-text">Donec id elit non mi porta gravida at eget metus. Maecenas sed diam eget risus varius blandit.</p>
Mark Otto's avatar
Mark Otto committed
124
125
  </a>
</div>
Mark Otto's avatar
Mark Otto committed
126
{% endexample %}