buttons.md 7.95 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: Buttons
4
group: components
5
redirect_from: "/components/"
Mark Otto's avatar
Mark Otto committed
6
---
Mark Otto's avatar
Mark Otto committed
7

Mark Otto's avatar
Mark Otto committed
8
Use Bootstrap's custom button styles for actions in forms, dialogs, and more. Includes support for a handful of contextual variations, sizes, states, and more.
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}

15
16
17
## Examples

Bootstrap includes six predefined button styles, each serving its own semantic purpose.
Mark Otto's avatar
Mark Otto committed
18
19

{% example html %}
Mark Otto's avatar
Mark Otto committed
20
21
22
<!-- Provides extra visual weight and identifies the primary action in a set of buttons -->
<button type="button" class="btn btn-primary">Primary</button>

23
24
25
<!-- Secondary, outline button -->
<button type="button" class="btn btn-secondary">Secondary</button>

Mark Otto's avatar
Mark Otto committed
26
27
28
29
30
31
32
33
34
35
36
<!-- Indicates a successful or positive action -->
<button type="button" class="btn btn-success">Success</button>

<!-- Indicates caution should be taken with this action -->
<button type="button" class="btn btn-warning">Warning</button>

<!-- Indicates a dangerous or potentially negative action -->
<button type="button" class="btn btn-danger">Danger</button>

<!-- Deemphasize a button by making it look like a link while maintaining button behavior -->
<button type="button" class="btn btn-link">Link</button>
Mark Otto's avatar
Mark Otto committed
37
38
{% endexample %}

39
40
41
42
43
{% callout warning %}
#### Conveying meaning to assistive technologies

Using color to add meaning to a button only provides a visual indication, which will not be conveyed to users of assistive technologies – such as screen readers. Ensure that information denoted by the color is either obvious from the content itself (the visible text of the button), or is included through alternative means, such as additional text hidden with the `.sr-only` class.
{% endcallout %}
Mark Otto's avatar
Mark Otto committed
44
45
46

## Button tags

Mark Otto's avatar
Mark Otto committed
47
The `.btn` classes are designed to be used with the `<button>` element. However, you can also use these classes on `<a>` or `<input>` elements (though some browsers may apply a slightly different rendering).
48

Mark Otto's avatar
Mark Otto committed
49
When using button classes on `<a>` elements that are used to trigger in-page functionality (like collapsing content), rather than linking to new pages or sections within the current page, these links should be given a `role="button"` to appropriately convey their purpose to assistive technologies such as screen readers.
Mark Otto's avatar
Mark Otto committed
50
51

{% example html %}
Mark Otto's avatar
Mark Otto committed
52
53
54
55
<a class="btn btn-primary" href="#" role="button">Link</a>
<button class="btn btn-primary" type="submit">Button</button>
<input class="btn btn-primary" type="button" value="Input">
<input class="btn btn-primary" type="submit" value="Submit">
Mark Otto's avatar
Mark Otto committed
56
57
{% endexample %}

Mark Otto's avatar
Mark Otto committed
58
59
## Outline buttons

60
In need of a button, but not the hefty background colors they bring? Replace the default modifier classes with the `.btn-*-outline` ones to remove all background images and colors on any button.
Mark Otto's avatar
Mark Otto committed
61
62

{% example html %}
Mark Otto's avatar
Mark Otto committed
63
64
65
66
67
<button type="button" class="btn btn-primary-outline">Primary</button>
<button type="button" class="btn btn-secondary-outline">Secondary</button>
<button type="button" class="btn btn-success-outline">Success</button>
<button type="button" class="btn btn-warning-outline">Warning</button>
<button type="button" class="btn btn-danger-outline">Danger</button>
Mark Otto's avatar
Mark Otto committed
68
69
70
{% endexample %}


Mark Otto's avatar
Mark Otto committed
71
72
## Sizes

73
Fancy larger or smaller buttons? Add `.btn-lg` or `.btn-sm` for additional sizes.
Mark Otto's avatar
Mark Otto committed
74
75
76
77
78
79
80
81
82
83
84
85
86
87

{% example html %}
<button type="button" class="btn btn-primary btn-lg">Large button</button>
<button type="button" class="btn btn-secondary btn-lg">Large button</button>
{% endexample %}

{% example html %}
<button type="button" class="btn btn-primary btn-sm">Small button</button>
<button type="button" class="btn btn-secondary btn-sm">Small button</button>
{% endexample %}

Create block level buttons—those that span the full width of a parent—by adding `.btn-block`.

{% example html %}
Mark Otto's avatar
Mark Otto committed
88
<button type="button" class="btn btn-primary btn-lg btn-block">Block level button</button>
Mark Otto's avatar
Mark Otto committed
89
<button type="button" class="btn btn-secondary btn-lg btn-block">Block level button</button>
Mark Otto's avatar
Mark Otto committed
90
91
92
93
{% endexample %}

## Active state

Mark Otto's avatar
Mark Otto committed
94
Buttons will appear pressed (with a darker background, darker border, and inset shadow) when active. **There's no need to add a class to `<button>`s as they use a pseudo-class**. However, you can still force the same active appearance with `.active` (and include the <code>aria-pressed="true"</code> attribute) should you need to replicate the state programmatically.
Mark Otto's avatar
Mark Otto committed
95
96

{% example html %}
Mark Otto's avatar
Mark Otto committed
97
<a href="#" class="btn btn-primary btn-lg active" role="button">Primary link</a>
Mark Otto's avatar
Mark Otto committed
98
<a href="#" class="btn btn-secondary btn-lg active" role="button">Link</a>
Mark Otto's avatar
Mark Otto committed
99
100
101
102
{% endexample %}

## Disabled state

Mark Otto's avatar
Mark Otto committed
103
104
105
106
107
Make buttons look inactive by adding the `disabled` boolean attribute to any `<button>` element.

{% callout info %}
**Heads up!** IE9 and below render disabled buttons with gray, shadowed text that we can't override.
{% endcallout %}
Mark Otto's avatar
Mark Otto committed
108
109
110
111
112
113
114
115
116

{% example html %}
<button type="button" class="btn btn-lg btn-primary" disabled>Primary button</button>
<button type="button" class="btn btn-secondary btn-lg" disabled>Button</button>
{% endexample %}

As `<a>` elements don't support the `disabled` attribute, you must add the `.disabled` class to fake it.

{% example html %}
Mark Otto's avatar
Mark Otto committed
117
<a href="#" class="btn btn-primary btn-lg disabled" role="button">Primary link</a>
Mark Otto's avatar
Mark Otto committed
118
<a href="#" class="btn btn-secondary btn-lg disabled" role="button">Link</a>
Mark Otto's avatar
Mark Otto committed
119
120
{% endexample %}

121
122
123
124
125
{% callout warning %}
#### Link functionality caveat

This class uses `pointer-events: none` to try to disable the link functionality of `<a>`s, but that CSS property is not yet standardized and isn't fully supported in Opera 18 and below, or in Internet Explorer 11\. In addition, even in browsers that do support `pointer-events: none`, keyboard navigation remains unaffected, meaning that sighted keyboard users and users of assistive technologies will still be able to activate these links. So to be safe, use custom JavaScript to disable such links.
{% endcallout %}
Mark Otto's avatar
Mark Otto committed
126

Mark Otto's avatar
Mark Otto committed
127
## Button plugin
128
129
130

Do more with buttons. Control button states or create groups of buttons for more components like toolbars.

Mark Otto's avatar
Mark Otto committed
131
### Toggle states
132
133
134
135
136
137
138
139
140

Add `data-toggle="button"` to toggle a button's `active` state. If you're pre-toggling a button, you must manually add the `.active` class **and** `aria-pressed="true"` to the `<button>`.

{% example html %}
<button type="button" class="btn btn-primary" data-toggle="button" aria-pressed="false" autocomplete="off">
  Single toggle
</button>
{% endexample %}

Mark Otto's avatar
Mark Otto committed
141
### Checkbox and radio buttons
142
143
144
145
146
147
148
149

Bootstrap's `.button` styles can be applied to other elements, such as `<label>`s, to provide checkbox or radio style button toggling. Add `data-toggle="buttons"` to a `.btn-group` containing those modified buttons to enable toggling in their respective styles.

The checked state for these buttons is **only updated via `click` event** on the button. If you use another method to update the input—e.g., with `<input type="reset">` or by manually applying the input's `checked` property—you'll need to toggle `.active` on the `<label>` manually.

Note that pre-checked buttons require you to manually add the `.active` class to the input's `<label>`.

{% example html %}
Mark Otto's avatar
Mark Otto committed
150
151
152
153
154
155
156
157
158
159
<div class="btn-group" data-toggle="buttons">
  <label class="btn btn-primary active">
    <input type="checkbox" checked autocomplete="off"> Checkbox 1 (pre-checked)
  </label>
  <label class="btn btn-primary">
    <input type="checkbox" autocomplete="off"> Checkbox 2
  </label>
  <label class="btn btn-primary">
    <input type="checkbox" autocomplete="off"> Checkbox 3
  </label>
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
</div>
{% endexample %}

{% example html %}
<div class="btn-group" data-toggle="buttons">
  <label class="btn btn-primary active">
    <input type="radio" name="options" id="option1" autocomplete="off" checked> Radio 1 (preselected)
  </label>
  <label class="btn btn-primary">
    <input type="radio" name="options" id="option2" autocomplete="off"> Radio 2
  </label>
  <label class="btn btn-primary">
    <input type="radio" name="options" id="option3" autocomplete="off"> Radio 3
  </label>
</div>
{% endexample %}

### Methods

Mark Otto's avatar
Mark Otto committed
179
180
181
| Method | Description |
| --- | --- |
| `$().button('toggle')` |Toggles push state. Gives the button the appearance that it has been activated.  |