list-group.md 4.73 KB
Newer Older
Mark Otto's avatar
Mark Otto committed
1
2
3
4
5
---
layout: page
title: List group
---

Mark Otto's avatar
Mark Otto committed
6
7
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
8
9
10
11
12
13
## Contents

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

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

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

Mark Otto's avatar
Mark Otto committed
26
## Badges
Mark Otto's avatar
Mark Otto committed
27
28
29
30

Add the badges component to any list group item and it will automatically be positioned on the right.

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

Mark Otto's avatar
Mark Otto committed
47
## Linked items
Mark Otto's avatar
Mark Otto committed
48
49
50
51

Linkify list group items by using anchor tags instead of list items (that also means a parent `<div>` instead of an `<ul>`). No need for individual parents around each element.

{% example html %}
Mark Otto's avatar
Mark Otto committed
52
53
54
55
56
57
58
59
60
<div class="list-group">
  <a href="#" class="list-group-item active">
    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
61
62
{% endexample %}

Mark Otto's avatar
Mark Otto committed
63
64
65
66
67
68
69
70
71
72
73
74
75
76
## Button items

List group items may be buttons instead of list items (that also means a parent `<div>` instead of an `<ul>`). No need for individual parents around each element. **Don't use the standard `.btn` classes here.**

{% example html %}
<div class="list-group">
  <button type="button" class="list-group-item">Cras justo odio</button>
  <button type="button" class="list-group-item">Dapibus ac facilisis in</button>
  <button type="button" class="list-group-item">Morbi leo risus</button>
  <button type="button" class="list-group-item">Porta ac consectetur ac</button>
  <button type="button" class="list-group-item">Vestibulum at eros</button>
</div>
{% endexample %}

Mark Otto's avatar
Mark Otto committed
77
## Disabled items
Mark Otto's avatar
Mark Otto committed
78
79
80
81

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

{% example html %}
Mark Otto's avatar
Mark Otto committed
82
83
84
85
86
87
88
89
90
<div class="list-group">
  <a href="#" class="list-group-item disabled">
    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
91
92
{% endexample %}

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

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

{% example html %}
Mark Otto's avatar
Mark Otto committed
98
99
100
101
102
103
104
105
106
107
108
109
<ul class="list-group">
  <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>
<div class="list-group">
  <a href="#" class="list-group-item list-group-item-success">Dapibus ac facilisis in</a>
  <a href="#" class="list-group-item list-group-item-info">Cras sit amet nibh libero</a>
  <a href="#" class="list-group-item list-group-item-warning">Porta ac consectetur ac</a>
  <a href="#" class="list-group-item list-group-item-danger">Vestibulum at eros</a>
</div>
Mark Otto's avatar
Mark Otto committed
110
111
{% endexample %}

Mark Otto's avatar
Mark Otto committed
112
## Custom content
Mark Otto's avatar
Mark Otto committed
113
114
115
116

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

{% example html %}
Mark Otto's avatar
Mark Otto committed
117
118
119
<div class="list-group">
  <a href="#" class="list-group-item active">
    <h4 class="list-group-item-heading">List group item heading</h4>
Mark Otto's avatar
Mark Otto committed
120
121
122
123
124
125
126
127
128
    <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>
  <a href="#" class="list-group-item">
    <h4 class="list-group-item-heading">List group item heading</h4>
    <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>
  <a href="#" class="list-group-item">
    <h4 class="list-group-item-heading">List group item heading</h4>
    <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
129
130
131
  </a>
</div>
</div>
Mark Otto's avatar
Mark Otto committed
132
{% endexample %}