input-groups.html 16.7 KB
Newer Older
Mark Otto's avatar
Mark Otto committed
1
2
3
<div class="bs-docs-section">
  <h1 id="input-groups" class="page-header">Input groups</h1>

4
  <p class="lead">Extend form controls by adding text or buttons before, after, or on both sides of any text-based <code>&lt;input&gt;</code>. Use <code>.input-group</code> with an <code>.input-group-addon</code> or <code>.input-group-btn</code> to prepend or append elements to a single <code>.form-control</code>.</p>
Mark Otto's avatar
Mark Otto committed
5

Chris Rebert's avatar
Chris Rebert committed
6
  <div class="bs-callout bs-callout-danger" id="callout-inputgroup-text-input-only">
7
    <h4>Textual <code>&lt;input&gt;</code>s only</h4>
Mark Otto's avatar
Mark Otto committed
8
    <p>Avoid using <code>&lt;select&gt;</code> elements here as they cannot be fully styled in WebKit browsers.</p>
9
    <p>Avoid using <code>&lt;textarea&gt;</code> elements here as their <code>rows</code> attribute will not be respected in some cases.</p>
Mark Otto's avatar
Mark Otto committed
10
  </div>
Chris Rebert's avatar
Chris Rebert committed
11
  <div class="bs-callout bs-callout-warning" id="callout-inputgroup-container-body">
Mark Otto's avatar
Mark Otto committed
12
13
14
    <h4>Tooltips &amp; popovers in input groups require special setting</h4>
    <p>When using tooltips or popovers on elements within an <code>.input-group</code>, you'll have to specify the option <code>container: 'body'</code> to avoid unwanted side effects (such as the element growing wider and/or losing its rounded corners when the tooltip or popover is triggered).</p>
  </div>
Chris Rebert's avatar
Chris Rebert committed
15
  <div class="bs-callout bs-callout-warning" id="callout-inputgroup-dont-mix">
Mark Otto's avatar
Mark Otto committed
16
17
18
    <h4>Don't mix with other components</h4>
    <p>Do not mix form groups or grid column classes directly with input groups. Instead, nest the input group inside of the form group or grid-related element.</p>
  </div>
19
20
21
22
23
  <div class="bs-callout bs-callout-warning" id="callout-inputgroup-form-labels">
    <h4>Always add labels</h4>
    <p>Screen readers will have trouble with your forms if you don't include a label for every input. For these input groups, ensure that any additional label or functionality is conveyed to assistive technologies.</p>
    <p>The exact technique to be used (<code>&lt;label&gt;</code> elements hidden using the <code>.sr-only</code> class, or use of the <code>aria-label</code>, <code>aria-labelledby</code>, <code>aria-describedby</code>, <code>title</code> or <code>placeholder</code> attribute) and what additional information will need to be conveyed will vary depending on the exact type of interface widget you're implementing. The examples in this section provide a few suggested, case-specific approaches.</p>
  </div>
Mark Otto's avatar
Mark Otto committed
24
25
26

  <h2 id="input-groups-basic">Basic example</h2>
  <p>Place one add-on or button on either side of an input. You may also place one on both sides of an input.</p>
27
  <p><strong class="text-danger">We do not support multiple add-ons (<code>.input-group-addon</code> or <code>.input-group-btn</code>) on a single side.</strong></p>
Mark Otto's avatar
Mark Otto committed
28
  <p><strong class="text-danger">We do not support multiple form-controls in a single input group.</strong></p>
29
  <form class="bs-example bs-example-form" data-example-id="simple-input-groups">
Mark Otto's avatar
Mark Otto committed
30
    <div class="input-group">
31
32
      <span class="input-group-addon" id="basic-addon1">@</span>
      <input type="text" class="form-control" placeholder="Username" aria-describedby="basic-addon1">
Mark Otto's avatar
Mark Otto committed
33
34
35
    </div>
    <br>
    <div class="input-group">
36
37
      <input type="text" class="form-control" placeholder="Recipient's username" aria-describedby="basic-addon2">
      <span class="input-group-addon" id="basic-addon2">@example.com</span>
Mark Otto's avatar
Mark Otto committed
38
39
40
41
    </div>
    <br>
    <div class="input-group">
      <span class="input-group-addon">$</span>
42
      <input type="text" class="form-control" aria-label="Amount (to the nearest dollar)">
Mark Otto's avatar
Mark Otto committed
43
44
45
46
47
      <span class="input-group-addon">.00</span>
    </div>
  </form>
{% highlight html %}
<div class="input-group">
48
49
  <span class="input-group-addon" id="basic-addon1">@</span>
  <input type="text" class="form-control" placeholder="Username" aria-describedby="basic-addon1">
Mark Otto's avatar
Mark Otto committed
50
51
52
</div>

<div class="input-group">
53
54
  <input type="text" class="form-control" placeholder="Recipient's username" aria-describedby="basic-addon2">
  <span class="input-group-addon" id="basic-addon2">@example.com</span>
Mark Otto's avatar
Mark Otto committed
55
56
57
58
</div>

<div class="input-group">
  <span class="input-group-addon">$</span>
59
  <input type="text" class="form-control" aria-label="Amount (to the nearest dollar)">
Mark Otto's avatar
Mark Otto committed
60
61
62
63
64
65
  <span class="input-group-addon">.00</span>
</div>
{% endhighlight %}

  <h2 id="input-groups-sizing">Sizing</h2>
  <p>Add the relative form sizing classes to the <code>.input-group</code> itself and contents within will automatically resize—no need for repeating the form control size classes on each element.</p>
66
  <form class="bs-example bs-example-form" data-example-id="input-group-sizing">
Mark Otto's avatar
Mark Otto committed
67
    <div class="input-group input-group-lg">
68
69
      <span class="input-group-addon" id="sizing-addon1">@</span>
      <input type="text" class="form-control" placeholder="Username" aria-describedby="sizing-addon1">
Mark Otto's avatar
Mark Otto committed
70
71
72
    </div>
    <br>
    <div class="input-group">
73
74
      <span class="input-group-addon" id="sizing-addon2">@</span>
      <input type="text" class="form-control" placeholder="Username" aria-describedby="sizing-addon2">
Mark Otto's avatar
Mark Otto committed
75
76
77
    </div>
    <br>
    <div class="input-group input-group-sm">
78
79
      <span class="input-group-addon" id="sizing-addon3">@</span>
      <input type="text" class="form-control" placeholder="Username" aria-describedby="sizing-addon3">
Mark Otto's avatar
Mark Otto committed
80
81
82
83
    </div>
  </form>
{% highlight html %}
<div class="input-group input-group-lg">
84
85
  <span class="input-group-addon" id="sizing-addon1">@</span>
  <input type="text" class="form-control" placeholder="Username" aria-describedby="sizing-addon1">
Mark Otto's avatar
Mark Otto committed
86
87
88
</div>

<div class="input-group">
89
90
  <span class="input-group-addon" id="sizing-addon2">@</span>
  <input type="text" class="form-control" placeholder="Username" aria-describedby="sizing-addon2">
Mark Otto's avatar
Mark Otto committed
91
92
93
</div>

<div class="input-group input-group-sm">
94
95
  <span class="input-group-addon" id="sizing-addon3">@</span>
  <input type="text" class="form-control" placeholder="Username" aria-describedby="sizing-addon3">
Mark Otto's avatar
Mark Otto committed
96
97
98
99
100
</div>
{% endhighlight %}

  <h2 id="input-groups-checkboxes-radios">Checkboxes and radio addons</h2>
  <p>Place any checkbox or radio option within an input group's addon instead of text.</p>
101
  <form class="bs-example bs-example-form" data-example-id="input-group-with-checkbox-radio">
Mark Otto's avatar
Mark Otto committed
102
103
104
105
    <div class="row">
      <div class="col-lg-6">
        <div class="input-group">
          <span class="input-group-addon">
106
            <input type="checkbox" aria-label="Checkbox for following text input">
Mark Otto's avatar
Mark Otto committed
107
          </span>
108
          <input type="text" class="form-control" aria-label="Text input with checkbox">
Mark Otto's avatar
Mark Otto committed
109
110
111
112
113
        </div><!-- /input-group -->
      </div><!-- /.col-lg-6 -->
      <div class="col-lg-6">
        <div class="input-group">
          <span class="input-group-addon">
114
            <input type="radio" aria-label="Radio button for following text input">
Mark Otto's avatar
Mark Otto committed
115
          </span>
116
          <input type="text" class="form-control" aria-label="Text input with radio button">
Mark Otto's avatar
Mark Otto committed
117
118
119
120
121
122
123
124
125
        </div><!-- /input-group -->
      </div><!-- /.col-lg-6 -->
    </div><!-- /.row -->
  </form>
{% highlight html %}
<div class="row">
  <div class="col-lg-6">
    <div class="input-group">
      <span class="input-group-addon">
126
        <input type="checkbox" aria-label="...">
Mark Otto's avatar
Mark Otto committed
127
      </span>
128
      <input type="text" class="form-control" aria-label="...">
Mark Otto's avatar
Mark Otto committed
129
130
131
132
133
    </div><!-- /input-group -->
  </div><!-- /.col-lg-6 -->
  <div class="col-lg-6">
    <div class="input-group">
      <span class="input-group-addon">
134
        <input type="radio" aria-label="...">
Mark Otto's avatar
Mark Otto committed
135
      </span>
136
      <input type="text" class="form-control" aria-label="...">
Mark Otto's avatar
Mark Otto committed
137
138
139
140
141
142
143
    </div><!-- /input-group -->
  </div><!-- /.col-lg-6 -->
</div><!-- /.row -->
{% endhighlight %}

  <h2 id="input-groups-buttons">Button addons</h2>
  <p>Buttons in input groups are a bit different and require one extra level of nesting. Instead of <code>.input-group-addon</code>, you'll need to use <code>.input-group-btn</code> to wrap the buttons. This is required due to default browser styles that cannot be overridden.</p>
144
  <form class="bs-example bs-example-form" data-example-id="input-group-with-button">
Mark Otto's avatar
Mark Otto committed
145
146
147
148
149
150
    <div class="row">
      <div class="col-lg-6">
        <div class="input-group">
          <span class="input-group-btn">
            <button class="btn btn-default" type="button">Go!</button>
          </span>
151
          <input type="text" class="form-control" placeholder="Search for...">
Mark Otto's avatar
Mark Otto committed
152
153
154
155
        </div><!-- /input-group -->
      </div><!-- /.col-lg-6 -->
      <div class="col-lg-6">
        <div class="input-group">
156
          <input type="text" class="form-control" placeholder="Search for...">
Mark Otto's avatar
Mark Otto committed
157
158
159
160
161
162
163
164
165
166
167
168
169
170
          <span class="input-group-btn">
            <button class="btn btn-default" type="button">Go!</button>
          </span>
        </div><!-- /input-group -->
      </div><!-- /.col-lg-6 -->
    </div><!-- /.row -->
  </form>
{% highlight html %}
<div class="row">
  <div class="col-lg-6">
    <div class="input-group">
      <span class="input-group-btn">
        <button class="btn btn-default" type="button">Go!</button>
      </span>
171
      <input type="text" class="form-control" placeholder="Search for...">
Mark Otto's avatar
Mark Otto committed
172
173
174
175
    </div><!-- /input-group -->
  </div><!-- /.col-lg-6 -->
  <div class="col-lg-6">
    <div class="input-group">
176
      <input type="text" class="form-control" placeholder="Search for...">
Mark Otto's avatar
Mark Otto committed
177
178
179
180
181
182
183
184
185
      <span class="input-group-btn">
        <button class="btn btn-default" type="button">Go!</button>
      </span>
    </div><!-- /input-group -->
  </div><!-- /.col-lg-6 -->
</div><!-- /.row -->
{% endhighlight %}

  <h2 id="input-groups-buttons-dropdowns">Buttons with dropdowns</h2>
186
  <form class="bs-example bs-example-form" data-example-id="input-group-dropdowns">
Mark Otto's avatar
Mark Otto committed
187
188
189
190
    <div class="row">
      <div class="col-lg-6">
        <div class="input-group">
          <div class="input-group-btn">
191
            <button type="button" class="btn btn-default dropdown-toggle" data-toggle="dropdown" aria-expanded="false">Action <span class="caret"></span></button>
Mark Otto's avatar
Mark Otto committed
192
193
194
195
196
197
198
199
            <ul class="dropdown-menu" role="menu">
              <li><a href="#">Action</a></li>
              <li><a href="#">Another action</a></li>
              <li><a href="#">Something else here</a></li>
              <li class="divider"></li>
              <li><a href="#">Separated link</a></li>
            </ul>
          </div><!-- /btn-group -->
200
          <input type="text" class="form-control" aria-label="Text input with dropdown button">
Mark Otto's avatar
Mark Otto committed
201
202
203
204
        </div><!-- /input-group -->
      </div><!-- /.col-lg-6 -->
      <div class="col-lg-6">
        <div class="input-group">
205
          <input type="text" class="form-control" aria-label="Text input with dropdown button">
Mark Otto's avatar
Mark Otto committed
206
          <div class="input-group-btn">
207
            <button type="button" class="btn btn-default dropdown-toggle" data-toggle="dropdown" aria-expanded="false">Action <span class="caret"></span></button>
Mark Otto's avatar
Mark Otto committed
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
            <ul class="dropdown-menu dropdown-menu-right" role="menu">
              <li><a href="#">Action</a></li>
              <li><a href="#">Another action</a></li>
              <li><a href="#">Something else here</a></li>
              <li class="divider"></li>
              <li><a href="#">Separated link</a></li>
            </ul>
          </div><!-- /btn-group -->
        </div><!-- /input-group -->
      </div><!-- /.col-lg-6 -->
    </div><!-- /.row -->
  </form>
{% highlight html %}
<div class="row">
  <div class="col-lg-6">
    <div class="input-group">
      <div class="input-group-btn">
225
        <button type="button" class="btn btn-default dropdown-toggle" data-toggle="dropdown" aria-expanded="false">Action <span class="caret"></span></button>
Chris Rebert's avatar
Chris Rebert committed
226
        <ul class="dropdown-menu" role="menu">
Mark Otto's avatar
Mark Otto committed
227
228
229
230
231
232
233
          <li><a href="#">Action</a></li>
          <li><a href="#">Another action</a></li>
          <li><a href="#">Something else here</a></li>
          <li class="divider"></li>
          <li><a href="#">Separated link</a></li>
        </ul>
      </div><!-- /btn-group -->
234
      <input type="text" class="form-control" aria-label="...">
Mark Otto's avatar
Mark Otto committed
235
236
237
238
    </div><!-- /input-group -->
  </div><!-- /.col-lg-6 -->
  <div class="col-lg-6">
    <div class="input-group">
239
      <input type="text" class="form-control" aria-label="...">
Mark Otto's avatar
Mark Otto committed
240
      <div class="input-group-btn">
241
        <button type="button" class="btn btn-default dropdown-toggle" data-toggle="dropdown" aria-expanded="false">Action <span class="caret"></span></button>
Chris Rebert's avatar
Chris Rebert committed
242
        <ul class="dropdown-menu dropdown-menu-right" role="menu">
Mark Otto's avatar
Mark Otto committed
243
244
245
246
247
248
249
250
251
252
253
254
255
          <li><a href="#">Action</a></li>
          <li><a href="#">Another action</a></li>
          <li><a href="#">Something else here</a></li>
          <li class="divider"></li>
          <li><a href="#">Separated link</a></li>
        </ul>
      </div><!-- /btn-group -->
    </div><!-- /input-group -->
  </div><!-- /.col-lg-6 -->
</div><!-- /.row -->
{% endhighlight %}

  <h2 id="input-groups-buttons-segmented">Segmented buttons</h2>
256
  <form class="bs-example bs-example-form" data-example-id="input-group-segmented-buttons">
Mark Otto's avatar
Mark Otto committed
257
258
259
260
    <div class="row">
      <div class="col-lg-6">
        <div class="input-group">
          <div class="input-group-btn">
261
            <button type="button" class="btn btn-default">Action</button>
262
            <button type="button" class="btn btn-default dropdown-toggle" data-toggle="dropdown" aria-expanded="false">
Mark Otto's avatar
Mark Otto committed
263
264
265
266
267
268
269
270
271
272
273
              <span class="caret"></span>
              <span class="sr-only">Toggle Dropdown</span>
            </button>
            <ul class="dropdown-menu" role="menu">
              <li><a href="#">Action</a></li>
              <li><a href="#">Another action</a></li>
              <li><a href="#">Something else here</a></li>
              <li class="divider"></li>
              <li><a href="#">Separated link</a></li>
            </ul>
          </div>
274
          <input type="text" class="form-control" aria-label="Text input with segmented button dropdown">
Mark Otto's avatar
Mark Otto committed
275
276
277
278
        </div><!-- /.input-group -->
      </div><!-- /.col-lg-6 -->
      <div class="col-lg-6">
        <div class="input-group">
279
          <input type="text" class="form-control" aria-label="Text input with segmented button dropdown">
Mark Otto's avatar
Mark Otto committed
280
          <div class="input-group-btn">
281
            <button type="button" class="btn btn-default">Action</button>
282
            <button type="button" class="btn btn-default dropdown-toggle" data-toggle="dropdown" aria-expanded="false">
Mark Otto's avatar
Mark Otto committed
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
              <span class="caret"></span>
              <span class="sr-only">Toggle Dropdown</span>
            </button>
            <ul class="dropdown-menu dropdown-menu-right" role="menu">
              <li><a href="#">Action</a></li>
              <li><a href="#">Another action</a></li>
              <li><a href="#">Something else here</a></li>
              <li class="divider"></li>
              <li><a href="#">Separated link</a></li>
            </ul>
          </div>
        </div><!-- /.input-group -->
      </div><!-- /.col-lg-6 -->
    </div><!-- /.row -->
  </form>
{% highlight html %}
<div class="input-group">
  <div class="input-group-btn">
    <!-- Button and dropdown menu -->
  </div>
303
  <input type="text" class="form-control" aria-label="...">
Mark Otto's avatar
Mark Otto committed
304
305
306
</div>

<div class="input-group">
307
  <input type="text" class="form-control" aria-label="...">
Mark Otto's avatar
Mark Otto committed
308
309
310
311
  <div class="input-group-btn">
    <!-- Button and dropdown menu -->
  </div>
</div>
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
{% endhighlight %}

  <h2 id="input-groups-buttons-multiple">Multiple buttons</h2>
  <p>While you can only have one add-on per side, you can have multiple buttons inside a single <code>.input-group-btn</code>.</p>
  <form class="bs-example bs-example-form" data-example-id="input-group-multiple-buttons">
    <div class="row">
      <div class="col-lg-6">
        <div class="input-group">
          <div class="input-group-btn">
            <button type="button" class="btn btn-default" aria-label="Bold"><span class="glyphicon glyphicon-bold"></span></button>
            <button type="button" class="btn btn-default" aria-label="Italic"><span class="glyphicon glyphicon-italic"></span></button>
          </div>
          <input type="text" class="form-control" aria-label="Text input with multiple buttons">
        </div><!-- /.input-group -->
      </div><!-- /.col-lg-6 -->
      <div class="col-lg-6">
        <div class="input-group">
          <input type="text" class="form-control" aria-label="Text input with multiple buttons">
          <div class="input-group-btn">
            <button type="button" class="btn btn-default" aria-label="Help"><span class="glyphicon glyphicon-question-sign"></span></button>
            <button type="button" class="btn btn-default">Action</button>
          </div>
        </div><!-- /.input-group -->
      </div><!-- /.col-lg-6 -->
    </div><!-- /.row -->
  </form>
{% highlight html %}
<div class="input-group">
  <div class="input-group-btn">
    <!-- Buttons -->
  </div>
  <input type="text" class="form-control" aria-label="...">
</div>

<div class="input-group">
  <input type="text" class="form-control" aria-label="...">
  <div class="input-group-btn">
    <!-- Buttons -->
  </div>
</div>
Mark Otto's avatar
Mark Otto committed
352
353
{% endhighlight %}
</div>