button-group.md 6.63 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: Button group
Mark Otto's avatar
Mark Otto committed
4
description: Group a series of buttons together on a single line with the button group, and super-power them with JavaScript.
5
group: components
Mark Otto's avatar
Mark Otto committed
6
7
---

Heinrich Fenkart's avatar
Heinrich Fenkart committed
8
Group a series of buttons together on a single line with the button group. Add on optional JavaScript radio and checkbox style behavior with [our buttons plugin]({{ site.baseurl }}/components/buttons/#button-plugin).
Mark Otto's avatar
Mark Otto committed
9

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

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

Mark Otto's avatar
Mark Otto committed
15
## Basic example
Mark Otto's avatar
Mark Otto committed
16

Mark Otto's avatar
Mark Otto committed
17
18
19
Wrap a series of buttons with `.btn` in `.btn-group`.

{% example html %}
Mark Otto's avatar
Mark Otto committed
20
<div class="btn-group" role="group" aria-label="Basic example">
Mark Otto's avatar
Mark Otto committed
21
22
23
  <button type="button" class="btn btn-secondary">Left</button>
  <button type="button" class="btn btn-secondary">Middle</button>
  <button type="button" class="btn btn-secondary">Right</button>
Mark Otto's avatar
Mark Otto committed
24
</div>
Mark Otto's avatar
Mark Otto committed
25
{% endexample %}
Mark Otto's avatar
Mark Otto committed
26

Mark Otto's avatar
Mark Otto committed
27
## Button toolbar
Mark Otto's avatar
Mark Otto committed
28
29
30
31

Combine sets of button groups into button toolbars for more complex components.

{% example html %}
Mark Otto's avatar
Mark Otto committed
32
33
<div class="btn-toolbar" role="toolbar" aria-label="Toolbar with button groups">
  <div class="btn-group" role="group" aria-label="First group">
Mark Otto's avatar
Mark Otto committed
34
35
36
37
38
    <button type="button" class="btn btn-secondary">1</button>
    <button type="button" class="btn btn-secondary">2</button>
    <button type="button" class="btn btn-secondary">3</button>
    <button type="button" class="btn btn-secondary">4</button>
  </div>
Mark Otto's avatar
Mark Otto committed
39
  <div class="btn-group" role="group" aria-label="Second group">
Mark Otto's avatar
Mark Otto committed
40
41
42
43
    <button type="button" class="btn btn-secondary">5</button>
    <button type="button" class="btn btn-secondary">6</button>
    <button type="button" class="btn btn-secondary">7</button>
  </div>
Mark Otto's avatar
Mark Otto committed
44
  <div class="btn-group" role="group" aria-label="Third group">
Mark Otto's avatar
Mark Otto committed
45
46
    <button type="button" class="btn btn-secondary">8</button>
  </div>
Mark Otto's avatar
Mark Otto committed
47
</div>
Mark Otto's avatar
Mark Otto committed
48
49
{% endexample %}

Mark Otto's avatar
Mark Otto committed
50
## Sizing
Mark Otto's avatar
Mark Otto committed
51

Mark Otto's avatar
Mark Otto committed
52
Instead of applying button sizing classes to every button in a group, just add `.btn-group-*` to each `.btn-group`, including each one when nesting multiple groups.
Mark Otto's avatar
Mark Otto committed
53

54
<div class="bd-example">
Mark Otto's avatar
Mark Otto committed
55
56
57
58
  <div class="btn-group btn-group-lg" role="group" aria-label="Large button group">
    <button type="button" class="btn btn-secondary">Left</button>
    <button type="button" class="btn btn-secondary">Middle</button>
    <button type="button" class="btn btn-secondary">Right</button>
Mark Otto's avatar
Mark Otto committed
59
  </div>
Mark Otto's avatar
Mark Otto committed
60
61
62
63
64
  <br>
  <div class="btn-group" role="group" aria-label="Default button group">
    <button type="button" class="btn btn-secondary">Left</button>
    <button type="button" class="btn btn-secondary">Middle</button>
    <button type="button" class="btn btn-secondary">Right</button>
Mark Otto's avatar
Mark Otto committed
65
  </div>
Mark Otto's avatar
Mark Otto committed
66
67
68
69
70
  <br>
  <div class="btn-group btn-group-sm" role="group" aria-label="Small button group">
    <button type="button" class="btn btn-secondary">Left</button>
    <button type="button" class="btn btn-secondary">Middle</button>
    <button type="button" class="btn btn-secondary">Right</button>
Mark Otto's avatar
Mark Otto committed
71
72
73
  </div>
</div>

Mark Otto's avatar
Mark Otto committed
74
{% highlight html %}
Mark Otto's avatar
Mark Otto committed
75
76
77
<div class="btn-group btn-group-lg" role="group" aria-label="...">...</div>
<div class="btn-group" role="group" aria-label="...">...</div>
<div class="btn-group btn-group-sm" role="group" aria-label="...">...</div>
Mark Otto's avatar
Mark Otto committed
78
79
{% endhighlight %}

Mark Otto's avatar
Mark Otto committed
80
## Nesting
Mark Otto's avatar
Mark Otto committed
81

Mark Otto's avatar
Mark Otto committed
82
83
84
Place a `.btn-group` within another `.btn-group` when you want dropdown menus mixed with a series of buttons.

{% example html %}
Mark Otto's avatar
Mark Otto committed
85
<div class="btn-group" role="group" aria-label="Button group with nested dropdown">
Mark Otto's avatar
Mark Otto committed
86
87
  <button type="button" class="btn btn-secondary">1</button>
  <button type="button" class="btn btn-secondary">2</button>
Mark Otto's avatar
Mark Otto committed
88

Mark Otto's avatar
Mark Otto committed
89
  <div class="btn-group" role="group">
Mark Otto's avatar
Mark Otto committed
90
    <button id="btnGroupDrop1" type="button" class="btn btn-secondary dropdown-toggle" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">
Mark Otto's avatar
Mark Otto committed
91
92
      Dropdown
    </button>
93
94
95
96
    <div class="dropdown-menu" aria-labelledby="btnGroupDrop1">
      <a class="dropdown-item" href="#">Dropdown link</a>
      <a class="dropdown-item" href="#">Dropdown link</a>
    </div>
Mark Otto's avatar
Mark Otto committed
97
98
  </div>
</div>
Mark Otto's avatar
Mark Otto committed
99
{% endexample %}
Mark Otto's avatar
Mark Otto committed
100

Mark Otto's avatar
Mark Otto committed
101
## Vertical variation
Mark Otto's avatar
Mark Otto committed
102
103
104

Make a set of buttons appear vertically stacked rather than horizontally. **Split button dropdowns are not supported here.**

105
<div class="bd-example">
Mark Otto's avatar
Mark Otto committed
106
  <div class="btn-group-vertical" role="group" aria-label="Vertical button group">
Mark Otto's avatar
Mark Otto committed
107
108
    <button type="button" class="btn btn-secondary">Button</button>
    <button type="button" class="btn btn-secondary">Button</button>
Mark Otto's avatar
Mark Otto committed
109
    <div class="btn-group" role="group">
Mark Otto's avatar
Mark Otto committed
110
      <button id="btnGroupVerticalDrop1" type="button" class="btn btn-secondary dropdown-toggle" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">
Mark Otto's avatar
Mark Otto committed
111
112
        Dropdown
      </button>
113
114
115
116
      <div class="dropdown-menu" aria-labelledby="btnGroupVerticalDrop1">
        <a class="dropdown-item" href="#">Dropdown link</a>
        <a class="dropdown-item" href="#">Dropdown link</a>
      </div>
Mark Otto's avatar
Mark Otto committed
117
118
119
    </div>
    <button type="button" class="btn btn-secondary">Button</button>
    <button type="button" class="btn btn-secondary">Button</button>
Mark Otto's avatar
Mark Otto committed
120
    <div class="btn-group" role="group">
Mark Otto's avatar
Mark Otto committed
121
      <button id="btnGroupVerticalDrop2" type="button" class="btn btn-secondary dropdown-toggle" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">
Mark Otto's avatar
Mark Otto committed
122
123
        Dropdown
      </button>
124
125
126
127
      <div class="dropdown-menu" aria-labelledby="btnGroupVerticalDrop2">
        <a class="dropdown-item" href="#">Dropdown link</a>
        <a class="dropdown-item" href="#">Dropdown link</a>
      </div>
Mark Otto's avatar
Mark Otto committed
128
    </div>
Mark Otto's avatar
Mark Otto committed
129
    <div class="btn-group" role="group">
Mark Otto's avatar
Mark Otto committed
130
      <button id="btnGroupVerticalDrop3" type="button" class="btn btn-secondary dropdown-toggle" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">
Mark Otto's avatar
Mark Otto committed
131
132
        Dropdown
      </button>
133
134
135
136
      <div class="dropdown-menu" aria-labelledby="btnGroupVerticalDrop3">
        <a class="dropdown-item" href="#">Dropdown link</a>
        <a class="dropdown-item" href="#">Dropdown link</a>
      </div>
Mark Otto's avatar
Mark Otto committed
137
    </div>
Mark Otto's avatar
Mark Otto committed
138
    <div class="btn-group" role="group">
Mark Otto's avatar
Mark Otto committed
139
      <button id="btnGroupVerticalDrop4" type="button" class="btn btn-secondary dropdown-toggle" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">
Mark Otto's avatar
Mark Otto committed
140
141
        Dropdown
      </button>
142
143
144
145
      <div class="dropdown-menu" aria-labelledby="btnGroupVerticalDrop4">
        <a class="dropdown-item" href="#">Dropdown link</a>
        <a class="dropdown-item" href="#">Dropdown link</a>
      </div>
Mark Otto's avatar
Mark Otto committed
146
147
    </div>
  </div>
Mark Otto's avatar
Mark Otto committed
148
149
</div>

Mark Otto's avatar
Mark Otto committed
150
151
152
153
154
{% highlight html %}
<div class="btn-group-vertical">
  ...
</div>
{% endhighlight %}
Mark Otto's avatar
Mark Otto committed
155
156
157
158

## Tooltips and popovers

Due to the specific implementation (and some other components), a bit of special casing is required for tooltips and popovers within button groups. **You'll have to specify the option `container: 'body'`** to avoid unwanted side effects (such as the element growing wider and/or losing its rounded corners when the tooltip or popover is triggered).