input-groups.html 14.9 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> 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
27
28

  <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>
  <p><strong class="text-danger">We do not support multiple add-ons on a single side.</strong></p>
  <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
101
</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>
102
  <form class="bs-example bs-example-form" data-example-id="input-group-with-checkbox-radio">
Mark Otto's avatar
Mark Otto committed
103
104
105
106
    <div class="row">
      <div class="col-lg-6">
        <div class="input-group">
          <span class="input-group-addon">
107
            <input type="checkbox" aria-label="Checkbox for following text input">
Mark Otto's avatar
Mark Otto committed
108
          </span>
109
          <input type="text" class="form-control" aria-label="Text input with checkbox">
Mark Otto's avatar
Mark Otto committed
110
111
112
113
114
        </div><!-- /input-group -->
      </div><!-- /.col-lg-6 -->
      <div class="col-lg-6">
        <div class="input-group">
          <span class="input-group-addon">
115
            <input type="radio" aria-label="Radio button for following text input">
Mark Otto's avatar
Mark Otto committed
116
          </span>
117
          <input type="text" class="form-control" aria-label="Text input with radio button">
Mark Otto's avatar
Mark Otto committed
118
119
120
121
122
123
124
125
126
        </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">
127
        <input type="checkbox" aria-label="...">
Mark Otto's avatar
Mark Otto committed
128
      </span>
129
      <input type="text" class="form-control" aria-label="...">
Mark Otto's avatar
Mark Otto committed
130
131
132
133
134
    </div><!-- /input-group -->
  </div><!-- /.col-lg-6 -->
  <div class="col-lg-6">
    <div class="input-group">
      <span class="input-group-addon">
135
        <input type="radio" aria-label="...">
Mark Otto's avatar
Mark Otto committed
136
      </span>
137
      <input type="text" class="form-control" aria-label="...">
Mark Otto's avatar
Mark Otto committed
138
139
140
141
142
143
144
145
    </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>
146
  <form class="bs-example bs-example-form" data-example-id="input-group-with-button">
Mark Otto's avatar
Mark Otto committed
147
148
149
150
151
152
    <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>
153
          <input type="text" class="form-control" placeholder="Search for...">
Mark Otto's avatar
Mark Otto committed
154
155
156
157
        </div><!-- /input-group -->
      </div><!-- /.col-lg-6 -->
      <div class="col-lg-6">
        <div class="input-group">
158
          <input type="text" class="form-control" placeholder="Search for...">
Mark Otto's avatar
Mark Otto committed
159
160
161
162
163
164
165
166
167
168
169
170
171
172
          <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>
173
      <input type="text" class="form-control" placeholder="Search for...">
Mark Otto's avatar
Mark Otto committed
174
175
176
177
    </div><!-- /input-group -->
  </div><!-- /.col-lg-6 -->
  <div class="col-lg-6">
    <div class="input-group">
178
      <input type="text" class="form-control" placeholder="Search for...">
Mark Otto's avatar
Mark Otto committed
179
180
181
182
183
184
185
186
187
188
      <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>
  <p></p>
189
  <form class="bs-example bs-example-form" data-example-id="input-group-dropdowns">
Mark Otto's avatar
Mark Otto committed
190
191
192
193
    <div class="row">
      <div class="col-lg-6">
        <div class="input-group">
          <div class="input-group-btn">
194
            <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
195
196
197
198
199
200
201
202
            <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 -->
203
          <input type="text" class="form-control" aria-label="Text input with dropdown button">
Mark Otto's avatar
Mark Otto committed
204
205
206
207
        </div><!-- /input-group -->
      </div><!-- /.col-lg-6 -->
      <div class="col-lg-6">
        <div class="input-group">
208
          <input type="text" class="form-control" aria-label="Text input with dropdown button">
Mark Otto's avatar
Mark Otto committed
209
          <div class="input-group-btn">
210
            <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
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
            <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">
228
        <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
229
        <ul class="dropdown-menu" role="menu">
Mark Otto's avatar
Mark Otto committed
230
231
232
233
234
235
236
          <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 -->
237
      <input type="text" class="form-control" aria-label="...">
Mark Otto's avatar
Mark Otto committed
238
239
240
241
    </div><!-- /input-group -->
  </div><!-- /.col-lg-6 -->
  <div class="col-lg-6">
    <div class="input-group">
242
      <input type="text" class="form-control" aria-label="...">
Mark Otto's avatar
Mark Otto committed
243
      <div class="input-group-btn">
244
        <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
245
        <ul class="dropdown-menu dropdown-menu-right" role="menu">
Mark Otto's avatar
Mark Otto committed
246
247
248
249
250
251
252
253
254
255
256
257
258
          <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>
259
  <form class="bs-example bs-example-form" data-example-id="input-group-segmented-buttons">
Mark Otto's avatar
Mark Otto committed
260
261
262
263
    <div class="row">
      <div class="col-lg-6">
        <div class="input-group">
          <div class="input-group-btn">
264
            <button type="button" class="btn btn-default">Action</button>
265
            <button type="button" class="btn btn-default dropdown-toggle" data-toggle="dropdown" aria-expanded="false">
Mark Otto's avatar
Mark Otto committed
266
267
268
269
270
271
272
273
274
275
276
              <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>
277
          <input type="text" class="form-control" aria-label="Text input with segmented button dropdown">
Mark Otto's avatar
Mark Otto committed
278
279
280
281
        </div><!-- /.input-group -->
      </div><!-- /.col-lg-6 -->
      <div class="col-lg-6">
        <div class="input-group">
282
          <input type="text" class="form-control" aria-label="Text input with segmented button dropdown">
Mark Otto's avatar
Mark Otto committed
283
          <div class="input-group-btn">
284
            <button type="button" class="btn btn-default">Action</button>
285
            <button type="button" class="btn btn-default dropdown-toggle" data-toggle="dropdown" aria-expanded="false">
Mark Otto's avatar
Mark Otto committed
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
              <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>
306
  <input type="text" class="form-control" aria-label="...">
Mark Otto's avatar
Mark Otto committed
307
308
309
</div>

<div class="input-group">
310
  <input type="text" class="form-control" aria-label="...">
Mark Otto's avatar
Mark Otto committed
311
312
313
314
315
316
  <div class="input-group-btn">
    <!-- Button and dropdown menu -->
  </div>
</div>
{% endhighlight %}
</div>