buttons.md 7.3 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
Mark Otto's avatar
Mark Otto committed
4
description: Use Bootstrap's custom button styles for actions in forms, dialogs, and more with support for multiple sizes, states, and more.
5
group: components
6
redirect_from: "/docs/4.0/components/"
Mark Otto's avatar
Mark Otto committed
7
toc: true
Mark Otto's avatar
Mark Otto committed
8
---
Mark Otto's avatar
Mark Otto committed
9

10
11
## Examples

12
Bootstrap includes several predefined button styles, each serving its own semantic purpose, with a few extras thrown in for more control.
Mark Otto's avatar
Mark Otto committed
13
14

{% example html %}
15
16
{% for color in site.data.theme-colors %}
<button type="button" class="btn btn-{{ color.name }}">{{ color.name | capitalize }}</button>{% endfor %}
Mark Otto's avatar
Mark Otto committed
17
18

<button type="button" class="btn btn-link">Link</button>
Mark Otto's avatar
Mark Otto committed
19
20
{% endexample %}

21
22
{% capture callout-include %}{% include callout-warning-color-assistive-technologies.md %}{% endcapture %}
{{ callout-include | markdownify }}
Mark Otto's avatar
Mark Otto committed
23
24
25

## Button tags

Mark Otto's avatar
Mark Otto committed
26
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).
27

Mark Otto's avatar
Mark Otto committed
28
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
29
30

{% example html %}
Mark Otto's avatar
Mark Otto committed
31
32
33
34
<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">
35
<input class="btn btn-primary" type="reset" value="Reset">
Mark Otto's avatar
Mark Otto committed
36
37
{% endexample %}

Mark Otto's avatar
Mark Otto committed
38
39
## Outline buttons

40
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
41
42

{% example html %}
43
44
{% for color in site.data.theme-colors %}
<button type="button" class="btn btn-outline-{{ color.name }}">{{ color.name | capitalize }}</button>{% endfor %}
Mark Otto's avatar
Mark Otto committed
45
46
{% endexample %}

Mark Otto's avatar
Mark Otto committed
47
48
## Sizes

49
Fancy larger or smaller buttons? Add `.btn-lg` or `.btn-sm` for additional sizes.
Mark Otto's avatar
Mark Otto committed
50
51
52
53
54
55
56
57
58
59
60
61
62
63

{% 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
64
<button type="button" class="btn btn-primary btn-lg btn-block">Block level button</button>
Mark Otto's avatar
Mark Otto committed
65
<button type="button" class="btn btn-secondary btn-lg btn-block">Block level button</button>
Mark Otto's avatar
Mark Otto committed
66
67
68
69
{% endexample %}

## Active state

Mark Otto's avatar
Mark Otto committed
70
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
71
72

{% example html %}
73
74
<a href="#" class="btn btn-primary btn-lg active" role="button" aria-pressed="true">Primary link</a>
<a href="#" class="btn btn-secondary btn-lg active" role="button" aria-pressed="true">Link</a>
Mark Otto's avatar
Mark Otto committed
75
76
77
78
{% endexample %}

## Disabled state

Mark Otto's avatar
Mark Otto committed
79
80
Make buttons look inactive by adding the `disabled` boolean attribute to any `<button>` element.

Mark Otto's avatar
Mark Otto committed
81
82
83
84
85
{% 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 %}

86
87
88
Disabled buttons using the `<a>` element behave a bit different:

- `<a>`s don't support the `disabled` attribute, so you must add the `.disabled` class to make it visually appear disabled.
89
- Some future-friendly styles are included to disable all `pointer-events` on anchor buttons. In browsers which support that property, you won't see the disabled cursor at all.
90
- Disabled buttons should include the `aria-disabled="true"` attribute to indicate the state of the element to assistive technologies.
Mark Otto's avatar
Mark Otto committed
91
92

{% example html %}
93
94
<a href="#" class="btn btn-primary btn-lg disabled" tabindex="-1" role="button" aria-disabled="true">Primary link</a>
<a href="#" class="btn btn-secondary btn-lg disabled" tabindex="-1" role="button" aria-disabled="true">Link</a>
Mark Otto's avatar
Mark Otto committed
95
96
{% endexample %}

97
{% callout warning %}
98
##### Link functionality caveat
99

100
The `.disabled` class uses `pointer-events: none` to try to disable the link functionality of `<a>`s, but that CSS property is not yet standardized. 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, add a `tabindex="-1"` attribute on these links (to prevent them from receiving keyboard focus) and use custom JavaScript to disable their functionality.
101
{% endcallout %}
Mark Otto's avatar
Mark Otto committed
102

Mark Otto's avatar
Mark Otto committed
103
## Button plugin
104
105
106

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

Mark Otto's avatar
Mark Otto committed
107
### Toggle states
108
109
110
111
112
113
114
115
116

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
117
### Checkbox and radio buttons
118

Mark Otto's avatar
Mark Otto committed
119
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 their toggling behavior via JavaScript and add `.btn-group-toggle` to style the `<input>`s within your buttons. **Note that you can create single input-powered buttons or groups of them.**
120
121
122
123
124
125

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 %}
126
<div class="btn-group-toggle" data-toggle="buttons">
127
  <label class="btn btn-secondary active">
128
    <input type="checkbox" checked autocomplete="off"> Checked
Mark Otto's avatar
Mark Otto committed
129
  </label>
130
131
132
133
</div>
{% endexample %}

{% example html %}
134
<div class="btn-group btn-group-toggle" data-toggle="buttons">
135
  <label class="btn btn-secondary active">
136
    <input type="radio" name="options" id="option1" autocomplete="off" checked> Active
137
  </label>
138
  <label class="btn btn-secondary">
139
    <input type="radio" name="options" id="option2" autocomplete="off"> Radio
140
  </label>
141
  <label class="btn btn-secondary">
142
    <input type="radio" name="options" id="option3" autocomplete="off"> Radio
143
144
145
146
147
148
  </label>
</div>
{% endexample %}

### Methods

Mark Otto's avatar
Mark Otto committed
149
150
| Method | Description |
| --- | --- |
151
152
| `$().button('toggle')` | Toggles push state. Gives the button the appearance that it has been activated. |
| `$().button('dispose')` | Destroys an element's button. |