buttons.md 8.75 KB
Newer Older
Mark Otto's avatar
Mark Otto committed
1
2
3
4
<div class="bs-docs-section">
  <h1 id="buttons" class="page-header">Buttons</h1>
  <p>Use any of the available button classes to quickly create a styled button.</p>
  <div class="bs-example">
Mark Otto's avatar
Mark Otto committed
5
6
    <p>
      <button type="button" class="btn btn-primary">Primary</button>
7
      <button type="button" class="btn btn-secondary">Secondary</button>
Mark Otto's avatar
Mark Otto committed
8
9
10
11
12
      <button type="button" class="btn btn-success">Success</button>
      <button type="button" class="btn btn-warning">Warning</button>
      <button type="button" class="btn btn-danger">Danger</button>
      <button type="button" class="btn btn-link">Link</button>
    </p>
Mark Otto's avatar
Mark Otto committed
13
14
15
16
17
  </div>
{% highlight html %}
<!-- Provides extra visual weight and identifies the primary action in a set of buttons -->
<button type="button" class="btn btn-primary">Primary</button>

18
19
20
<!-- Secondary, outline button -->
<button type="button" class="btn btn-secondary">Secondary</button>

Mark Otto's avatar
Mark Otto committed
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
<!-- 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>
{% endhighlight %}

  <h2 id="buttons-sizes">Sizes</h2>
  <p>Fancy larger or smaller buttons? Add <code>.btn-lg</code>, <code>.btn-sm</code>, or <code>.btn-xs</code> for additional sizes.</p>
  <div class="bs-example">
    <p>
      <button type="button" class="btn btn-primary btn-lg">Large button</button>
Mark Otto's avatar
Mark Otto committed
39
      <button type="button" class="btn btn-secondary btn-lg">Large button</button>
Mark Otto's avatar
Mark Otto committed
40
41
42
    </p>
    <p>
      <button type="button" class="btn btn-primary">Default button</button>
Mark Otto's avatar
Mark Otto committed
43
      <button type="button" class="btn btn-secondary">Default button</button>
Mark Otto's avatar
Mark Otto committed
44
45
46
    </p>
    <p>
      <button type="button" class="btn btn-primary btn-sm">Small button</button>
Mark Otto's avatar
Mark Otto committed
47
      <button type="button" class="btn btn-secondary btn-sm">Small button</button>
Mark Otto's avatar
Mark Otto committed
48
49
50
    </p>
    <p>
      <button type="button" class="btn btn-primary btn-xs">Extra small button</button>
Mark Otto's avatar
Mark Otto committed
51
      <button type="button" class="btn btn-secondary btn-xs">Extra small button</button>
Mark Otto's avatar
Mark Otto committed
52
53
54
55
56
    </p>
  </div>
{% highlight html %}
<p>
  <button type="button" class="btn btn-primary btn-lg">Large button</button>
Mark Otto's avatar
Mark Otto committed
57
  <button type="button" class="btn btn-secondary btn-lg">Large button</button>
Mark Otto's avatar
Mark Otto committed
58
59
60
</p>
<p>
  <button type="button" class="btn btn-primary">Default button</button>
Mark Otto's avatar
Mark Otto committed
61
  <button type="button" class="btn btn-secondary">Default button</button>
Mark Otto's avatar
Mark Otto committed
62
63
64
</p>
<p>
  <button type="button" class="btn btn-primary btn-sm">Small button</button>
Mark Otto's avatar
Mark Otto committed
65
  <button type="button" class="btn btn-secondary btn-sm">Small button</button>
Mark Otto's avatar
Mark Otto committed
66
67
68
</p>
<p>
  <button type="button" class="btn btn-primary btn-xs">Extra small button</button>
Mark Otto's avatar
Mark Otto committed
69
  <button type="button" class="btn btn-secondary btn-xs">Extra small button</button>
Mark Otto's avatar
Mark Otto committed
70
71
72
73
74
75
76
</p>
{% endhighlight %}

  <p>Create block level buttons&mdash;those that span the full width of a parent&mdash; by adding <code>.btn-block</code>.</p>
  <div class="bs-example">
    <div class="well" style="max-width: 400px; margin: 0 auto 10px;">
      <button type="button" class="btn btn-primary btn-lg btn-block">Block level button</button>
Mark Otto's avatar
Mark Otto committed
77
      <button type="button" class="btn btn-secondary btn-lg btn-block">Block level button</button>
Mark Otto's avatar
Mark Otto committed
78
79
80
81
    </div>
  </div>
{% highlight html %}
<button type="button" class="btn btn-primary btn-lg btn-block">Block level button</button>
Mark Otto's avatar
Mark Otto committed
82
<button type="button" class="btn btn-secondary btn-lg btn-block">Block level button</button>
Mark Otto's avatar
Mark Otto committed
83
84
85
86
{% endhighlight %}


  <h2 id="buttons-active">Active state</h2>
Ilya Radchenko's avatar
Ilya Radchenko committed
87
  <p>Buttons will appear pressed (with a darker background, darker border, and inset shadow) when active. For <code>&lt;button&gt;</code> elements, this is done via <code>:active</code>. For <code>&lt;a&gt;</code> elements, it's done with <code>.active</code>. However, you may use <code>.active</code> on <code>&lt;button&gt;</code>s should you need to replicate the active state programmatically.</p>
Mark Otto's avatar
Mark Otto committed
88
89
90
91
92

  <h3>Button element</h3>
  <p>No need to add <code>:active</code> as it's a pseudo-class, but if you need to force the same appearance, go ahead and add <code>.active</code>.</p>
  <p class="bs-example">
    <button type="button" class="btn btn-primary btn-lg active">Primary button</button>
Mark Otto's avatar
Mark Otto committed
93
    <button type="button" class="btn btn-secondary btn-lg active">Button</button>
Mark Otto's avatar
Mark Otto committed
94
95
96
  </p>
{% highlight html %}
<button type="button" class="btn btn-primary btn-lg active">Primary button</button>
Mark Otto's avatar
Mark Otto committed
97
<button type="button" class="btn btn-secondary btn-lg active">Button</button>
Mark Otto's avatar
Mark Otto committed
98
99
100
101
102
103
{% endhighlight %}

  <h3>Anchor element</h3>
  <p>Add the <code>.active</code> class to <code>&lt;a&gt;</code> buttons.</p>
  <p class="bs-example">
    <a href="#" class="btn btn-primary btn-lg active" role="button">Primary link</a>
Mark Otto's avatar
Mark Otto committed
104
    <a href="#" class="btn btn-secondary btn-lg active" role="button">Link</a>
Mark Otto's avatar
Mark Otto committed
105
106
107
  </p>
{% highlight html %}
<a href="#" class="btn btn-primary btn-lg active" role="button">Primary link</a>
Mark Otto's avatar
Mark Otto committed
108
<a href="#" class="btn btn-secondary btn-lg active" role="button">Link</a>
Mark Otto's avatar
Mark Otto committed
109
110
111
112
113
114
115
116
117
118
{% endhighlight %}


  <h2 id="buttons-disabled">Disabled state</h2>
  <p>Make buttons look unclickable by fading them back 50%.</p>

  <h3>Button element</h3>
  <p>Add the <code>disabled</code> attribute to <code>&lt;button&gt;</code> buttons.</p>
  <p class="bs-example">
    <button type="button" class="btn btn-primary btn-lg" disabled="disabled">Primary button</button>
Mark Otto's avatar
Mark Otto committed
119
    <button type="button" class="btn btn-secondary btn-lg" disabled="disabled">Button</button>
Mark Otto's avatar
Mark Otto committed
120
121
122
  </p>
{% highlight html %}
<button type="button" class="btn btn-lg btn-primary" disabled="disabled">Primary button</button>
Mark Otto's avatar
Mark Otto committed
123
<button type="button" class="btn btn-secondary btn-lg" disabled="disabled">Button</button>
Mark Otto's avatar
Mark Otto committed
124
125
126
127
128
129
130
131
132
133
134
{% endhighlight %}

  <div class="bs-callout bs-callout-danger">
    <h4>Cross-browser compatibility</h4>
    <p>If you add the <code>disabled</code> attribute to a <code>&lt;button&gt;</code>, Internet Explorer 9 and below will render text gray with a nasty text-shadow that we cannot fix.</p>
  </div>

  <h3>Anchor element</h3>
  <p>Add the <code>.disabled</code> class to <code>&lt;a&gt;</code> buttons.</p>
  <p class="bs-example">
    <a href="#" class="btn btn-primary btn-lg disabled" role="button">Primary link</a>
Mark Otto's avatar
Mark Otto committed
135
    <a href="#" class="btn btn-secondary btn-lg disabled" role="button">Link</a>
Mark Otto's avatar
Mark Otto committed
136
137
138
  </p>
{% highlight html %}
<a href="#" class="btn btn-primary btn-lg disabled" role="button">Primary link</a>
Mark Otto's avatar
Mark Otto committed
139
<a href="#" class="btn btn-secondary btn-lg disabled" role="button">Link</a>
Mark Otto's avatar
Mark Otto committed
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
{% endhighlight %}
  <p>
    We use <code>.disabled</code> as a utility class here, similar to the common <code>.active</code> class, so no prefix is required.
  </p>
  <div class="bs-callout bs-callout-warning">
    <h4>Link functionality caveat</h4>
    <p>This class uses <code>pointer-events: none</code> to try to disable the link functionality of <code>&lt;a&gt;</code>s, but that CSS property is not yet standardized and isn't fully supported in Opera 18 and below, or in Internet Explorer 11. So to be safe, use custom JavaScript to disable such links.</p>
  </div>
  <div class="bs-callout bs-callout-warning">
    <h4>Context-specific usage</h4>
    <p>While button classes can be used on <code>&lt;a&gt;</code> and <code>&lt;button&gt;</code> elements, only <code>&lt;button&gt;</code> elements are supported within our nav and navbar components.</p>
  </div>


  <h2 id="buttons-tags">Button tags</h2>
  <p>Use the button classes on an <code>&lt;a&gt;</code>, <code>&lt;button&gt;</code>, or <code>&lt;input&gt;</code> element.</p>
  <form class="bs-example">
Mark Otto's avatar
Mark Otto committed
157
158
159
160
    <a class="btn btn-secondary" href="#" role="button">Link</a>
    <button class="btn btn-secondary" type="submit">Button</button>
    <input class="btn btn-secondary" type="button" value="Input">
    <input class="btn btn-secondary" type="submit" value="Submit">
Mark Otto's avatar
Mark Otto committed
161
162
  </form>
{% highlight html %}
Mark Otto's avatar
Mark Otto committed
163
164
165
166
<a class="btn btn-secondary" href="#" role="button">Link</a>
<button class="btn btn-secondary" type="submit">Button</button>
<input class="btn btn-secondary" type="button" value="Input">
<input class="btn btn-secondary" type="submit" value="Submit">
Mark Otto's avatar
Mark Otto committed
167
168
169
170
171
{% endhighlight %}

  <div class="bs-callout bs-callout-warning">
    <h4>Cross-browser rendering</h4>
    <p>As a best practice, <strong>we highly recommend using the <code>&lt;button&gt;</code> element whenever possible</strong> to ensure matching cross-browser rendering.</p>
172
    <p>Among other things, there's <a href="https://bugzilla.mozilla.org/show_bug.cgi?id=697451">a bug in Firefox &lt;30</a> that prevents us from setting the <code>line-height</code> of <code>&lt;input&gt;</code>-based buttons, causing them to not exactly match the height of other buttons on Firefox.</p>
Mark Otto's avatar
Mark Otto committed
173
174
  </div>
</div>