forms.md 38.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: Forms
Mark Otto's avatar
Mark Otto committed
4
description: Examples and usage guidelines for from controls, form layouts, and custom forms.
5
group: components
Mark Otto's avatar
Mark Otto committed
6
7
---

8
Bootstrap provides several form control styles, layout options, and custom components for creating a wide variety of forms.
Mark Otto's avatar
Mark Otto committed
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
## Form controls
Mark Otto's avatar
Mark Otto committed
16

17
Bootstrap's form controls expand on [our Rebooted form styles]({{ site.baseurl }}/content/reboot/#forms) with classes. Use these classes to opt into their customized displays for a more consistent rendering across browsers and devices. The example form below demonstrates common HTML form elements that receive updated styles from Bootstrap with additional classes.
Mark Otto's avatar
Mark Otto committed
18

19
Remember, since Bootstrap utilizes the HTML5 doctype, **all inputs must have a `type` attribute**.
20

Mark Otto's avatar
Mark Otto committed
21
{% example html %}
Mark Otto's avatar
Mark Otto committed
22
<form>
23
  <div class="form-group">
Mark Otto's avatar
Mark Otto committed
24
    <label for="exampleInputEmail1">Email address</label>
25
    <input type="email" class="form-control" id="exampleInputEmail1" aria-describedby="emailHelp" placeholder="Enter email">
26
    <small id="emailHelp" class="form-text text-muted">We'll never share your email with anyone else.</small>
27
28
  </div>
  <div class="form-group">
Mark Otto's avatar
Mark Otto committed
29
30
    <label for="exampleInputPassword1">Password</label>
    <input type="password" class="form-control" id="exampleInputPassword1" placeholder="Password">
31
32
  </div>
  <div class="form-group">
33
    <label for="exampleSelect1">Example select</label>
34
    <select class="form-control" id="exampleSelect1">
35
36
37
38
39
40
      <option>1</option>
      <option>2</option>
      <option>3</option>
      <option>4</option>
      <option>5</option>
    </select>
41
42
  </div>
  <div class="form-group">
43
    <label for="exampleSelect2">Example multiple select</label>
44
    <select multiple class="form-control" id="exampleSelect2">
45
46
47
48
49
50
      <option>1</option>
      <option>2</option>
      <option>3</option>
      <option>4</option>
      <option>5</option>
    </select>
51
52
  </div>
  <div class="form-group">
53
54
    <label for="exampleTextarea">Example textarea</label>
    <textarea class="form-control" id="exampleTextarea" rows="3"></textarea>
55
56
  </div>
  <div class="form-group">
Mark Otto's avatar
Mark Otto committed
57
    <label for="exampleInputFile">File input</label>
58
    <input type="file" class="form-control-file" id="exampleInputFile" aria-describedby="fileHelp">
59
    <small id="fileHelp" class="form-text text-muted">This is some placeholder block-level help text for the above input. It's a bit lighter and easily wraps to a new line.</small>
Mark Otto's avatar
Mark Otto committed
60
  </div>
61
62
  <fieldset class="form-group">
    <legend>Radio buttons</legend>
63
64
65
    <div class="form-check">
      <label class="form-check-label">
        <input type="radio" class="form-check-input" name="optionsRadios" id="optionsRadios1" value="option1" checked>
66
67
68
        Option one is this and that&mdash;be sure to include why it's great
      </label>
    </div>
69
70
71
    <div class="form-check">
    <label class="form-check-label">
        <input type="radio" class="form-check-input" name="optionsRadios" id="optionsRadios2" value="option2">
72
73
74
        Option two can be something else and selecting it will deselect option one
      </label>
    </div>
75
76
77
    <div class="form-check disabled">
    <label class="form-check-label">
        <input type="radio" class="form-check-input" name="optionsRadios" id="optionsRadios3" value="option3" disabled>
78
79
80
81
        Option three is disabled
      </label>
    </div>
  </fieldset>
82
83
84
85
  <div class="form-check">
    <label class="form-check-label">
      <input type="checkbox" class="form-check-input">
      Check me out
Mark Otto's avatar
Mark Otto committed
86
87
    </label>
  </div>
Mark Otto's avatar
Mark Otto committed
88
  <button type="submit" class="btn btn-primary">Submit</button>
Mark Otto's avatar
Mark Otto committed
89
</form>
Mark Otto's avatar
Mark Otto committed
90
{% endexample %}
Mark Otto's avatar
Mark Otto committed
91

92
Below is a complete list of the specific form controls supported by Bootstrap and the classes that customize them. Additional documentation is available for each group.
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121

<table>
  <thead>
    <tr>
      <th>Classes</th>
      <th>Used for</th>
      <th>Supported variations</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td>
        {% markdown %}`.form-group`{% endmarkdown %}
      </td>
      <td class="text-nowrap">
        Any group of form controls
      </td>
      <td>
        {% markdown %}Use with any block-level element like `<fieldset>` or `<div>`{% endmarkdown %}
      </td>
    </tr>
    <tr>
      <td rowspan="3">
        {% markdown %}`.form-control`{% endmarkdown %}
      </td>
      <td>
        Textual inputs
      </td>
      <td>
122
        {% markdown %}`text`, `password`, `datetime-local`, `date`, `month`, `time`, `week`, `number`, `email`, `url`, `search`, `tel`, `color`{% endmarkdown %}
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
      </td>
    </tr>
    <tr>
      <td>
        Select menus
      </td>
      <td>
        {% markdown %}`multiple`, `size`{% endmarkdown %}
      </td>
    </tr>
    <tr>
      <td>
        Textareas
      </td>
      <td>
        <span class="text-muted">N/A</span>
      </td>
    </tr>
    <tr>
      <td class="text-nowrap">
        {% markdown %}`.form-control-file`{% endmarkdown %}
      </td>
      <td>
        File inputs
      </td>
      <td>
        {% markdown %}`file`{% endmarkdown %}
      </td>
    </tr>
    <tr>
      <td class="text-nowrap">
{% markdown %}
155
156
`.form-check`<br>
`.form-check-inline`
157
158
159
160
161
162
163
164
165
166
167
168
{% endmarkdown %}
      </td>
      <td class="text-nowrap">
        Checkboxes and radios
      </td>
      <td>
        <span class="text-muted">N/A</span>
      </td>
    </tr>
  </tbody>
</table>

169
170
171
172
173
174
### Textual inputs

Here are examples of `.form-control` applied to each textual HTML5 `<input>` `type`.

{% example html %}
<div class="form-group row">
175
  <label for="example-text-input" class="col-xs-2 col-form-label">Text</label>
176
177
178
179
180
  <div class="col-xs-10">
    <input class="form-control" type="text" value="Artisanal kale" id="example-text-input">
  </div>
</div>
<div class="form-group row">
181
  <label for="example-search-input" class="col-xs-2 col-form-label">Search</label>
182
183
184
185
186
  <div class="col-xs-10">
    <input class="form-control" type="search" value="How do I shoot web" id="example-search-input">
  </div>
</div>
<div class="form-group row">
187
  <label for="example-email-input" class="col-xs-2 col-form-label">Email</label>
188
189
190
191
192
  <div class="col-xs-10">
    <input class="form-control" type="email" value="bootstrap@example.com" id="example-email-input">
  </div>
</div>
<div class="form-group row">
193
  <label for="example-url-input" class="col-xs-2 col-form-label">URL</label>
194
  <div class="col-xs-10">
195
    <input class="form-control" type="url" value="https://getbootstrap.com" id="example-url-input">
196
197
198
  </div>
</div>
<div class="form-group row">
199
  <label for="example-tel-input" class="col-xs-2 col-form-label">Telephone</label>
200
201
202
203
204
  <div class="col-xs-10">
    <input class="form-control" type="tel" value="1-(555)-555-5555" id="example-tel-input">
  </div>
</div>
<div class="form-group row">
205
  <label for="example-password-input" class="col-xs-2 col-form-label">Password</label>
206
207
208
209
210
  <div class="col-xs-10">
    <input class="form-control" type="password" value="hunter2" id="example-password-input">
  </div>
</div>
<div class="form-group row">
211
  <label for="example-number-input" class="col-xs-2 col-form-label">Number</label>
212
213
214
215
216
  <div class="col-xs-10">
    <input class="form-control" type="number" value="42" id="example-number-input">
  </div>
</div>
<div class="form-group row">
217
  <label for="example-datetime-local-input" class="col-xs-2 col-form-label">Date and time</label>
218
219
220
221
222
  <div class="col-xs-10">
    <input class="form-control" type="datetime-local" value="2011-08-19T13:45:00" id="example-datetime-local-input">
  </div>
</div>
<div class="form-group row">
223
  <label for="example-date-input" class="col-xs-2 col-form-label">Date</label>
224
225
226
227
228
  <div class="col-xs-10">
    <input class="form-control" type="date" value="2011-08-19" id="example-date-input">
  </div>
</div>
<div class="form-group row">
229
  <label for="example-month-input" class="col-xs-2 col-form-label">Month</label>
230
231
232
233
234
  <div class="col-xs-10">
    <input class="form-control" type="month" value="2011-08" id="example-month-input">
  </div>
</div>
<div class="form-group row">
235
  <label for="example-week-input" class="col-xs-2 col-form-label">Week</label>
236
237
238
239
240
  <div class="col-xs-10">
    <input class="form-control" type="week" value="2011-W33" id="example-week-input">
  </div>
</div>
<div class="form-group row">
241
  <label for="example-time-input" class="col-xs-2 col-form-label">Time</label>
242
243
244
245
246
  <div class="col-xs-10">
    <input class="form-control" type="time" value="13:45:00" id="example-time-input">
  </div>
</div>
<div class="form-group row">
247
  <label for="example-color-input" class="col-xs-2 col-form-label">Color</label>
248
249
250
251
252
253
  <div class="col-xs-10">
    <input class="form-control" type="color" value="#563d7c" id="example-color-input">
  </div>
</div>
{% endexample %}

254
255
256
257
258
259
## Form layouts

Since Bootstrap applies `display: block` and `width: 100%` to almost all our form controls, forms will by default stack vertically. Additional classes can be used to vary this layout on a per-form basis.

### Form groups

260
The `.form-group` class is the easiest way to add some structure to forms. Its only purpose is to provide `margin-bottom` around a label and control pairing. As a bonus, since it's a class you can use it with `<fieldset>`s, `<div>`s, or nearly any other element.
Mark Otto's avatar
Mark Otto committed
261

262
263
{% example html %}
<form>
264
  <div class="form-group">
265
    <label for="formGroupExampleInput">Example label</label>
266
    <input type="text" class="form-control" id="formGroupExampleInput" placeholder="Example input">
267
268
  </div>
  <div class="form-group">
269
    <label for="formGroupExampleInput2">Another label</label>
270
    <input type="text" class="form-control" id="formGroupExampleInput2" placeholder="Another input">
271
  </div>
272
273
274
275
276
</form>
{% endexample %}

### Inline forms

cndpzc's avatar
cndpzc committed
277
Use the `.form-inline` class to display a series of labels, form controls, and buttons on a single horizontal row. Form controls within inline forms behave differently:
278
279
280
281

- Controls are `display: inline-block` to provide alignment control via `vertical-align` and `margin`.
- Controls receive `width: auto` to override the Bootstrap default `width: 100%`.
- Controls **only appear inline in viewports that are at least 768px wide** to account for narrow viewports on mobile devices.
Mark Otto's avatar
Mark Otto committed
282

Chris Rebert's avatar
Chris Rebert committed
283
Because of this, you may need to manually address the width and alignment of individual form controls. Lastly, as shown below, you should always include a `<label>` with each form control.
Mark Otto's avatar
Mark Otto committed
284

285
#### Visible labels
Mark Otto's avatar
Mark Otto committed
286
287

{% example html %}
288
289
290
291
292
293
294
295
296
297
298
<form class="form-inline">
  <div class="form-group">
    <label for="exampleInputName2">Name</label>
    <input type="text" class="form-control" id="exampleInputName2" placeholder="Jane Doe">
  </div>
  <div class="form-group">
    <label for="exampleInputEmail2">Email</label>
    <input type="email" class="form-control" id="exampleInputEmail2" placeholder="jane.doe@example.com">
  </div>
  <button type="submit" class="btn btn-primary">Send invitation</button>
</form>
Mark Otto's avatar
Mark Otto committed
299
300
{% endexample %}

301
#### Hidden labels
Mark Otto's avatar
Mark Otto committed
302

Mark Otto's avatar
Mark Otto committed
303
{% example html %}
Mark Otto's avatar
Mark Otto committed
304
<form class="form-inline">
Mark Otto's avatar
Mark Otto committed
305
  <div class="form-group">
Mark Otto's avatar
Mark Otto committed
306
307
    <label class="sr-only" for="exampleInputEmail3">Email address</label>
    <input type="email" class="form-control" id="exampleInputEmail3" placeholder="Enter email">
Mark Otto's avatar
Mark Otto committed
308
309
  </div>
  <div class="form-group">
Mark Otto's avatar
Mark Otto committed
310
311
    <label class="sr-only" for="exampleInputPassword3">Password</label>
    <input type="password" class="form-control" id="exampleInputPassword3" placeholder="Password">
Mark Otto's avatar
Mark Otto committed
312
  </div>
313
314
315
  <div class="form-check">
    <label class="form-check-label">
      <input class="form-check-input" type="checkbox"> Remember me
Mark Otto's avatar
Mark Otto committed
316
317
    </label>
  </div>
Mark Otto's avatar
Mark Otto committed
318
  <button type="submit" class="btn btn-primary">Sign in</button>
Mark Otto's avatar
Mark Otto committed
319
320
321
322
323
324
325
326
327
328
329
330
331
332
</form>
{% endexample %}

{% example html %}
<form class="form-inline">
  <div class="form-group">
    <label class="sr-only" for="exampleInputAmount">Amount (in dollars)</label>
    <div class="input-group">
      <div class="input-group-addon">$</div>
      <input type="text" class="form-control" id="exampleInputAmount" placeholder="Amount">
      <div class="input-group-addon">.00</div>
    </div>
  </div>
  <button type="submit" class="btn btn-primary">Transfer cash</button>
Mark Otto's avatar
Mark Otto committed
333
</form>
Mark Otto's avatar
Mark Otto committed
334
{% endexample %}
Mark Otto's avatar
Mark Otto committed
335

336
{% callout warning %}
Mark Otto's avatar
Mark Otto committed
337
338
339
#### Alternatives to hidden labels
Assistive technologies such as screen readers will have trouble with your forms if you don't include a label for every input. For these inline forms, you can hide the labels using the `.sr-only` class. There are further alternative methods of providing a label for assistive technologies, such as the `aria-label`, `aria-labelledby` or `title` attribute. If none of these are present, assistive technologies may resort to using the `placeholder` attribute, if present, but note that use of `placeholder` as a replacement for other labelling methods is not advised.
{% endcallout %}
340

341
### Using the Grid
Mark Otto's avatar
Mark Otto committed
342

343
For more structured form layouts that are also responsive, you can utilize Bootstrap's [predefined grid classes]({{ site.baseurl }}/layout/grid/#predefined-classes) or [mixins]({{ site.baseurl }}/layout/grid/#sass-mixins) to create horizontal forms. Add the `.row` class to form groups and use the `.col-*-*` classes to specify the width of your labels and controls.
Mark Otto's avatar
Mark Otto committed
344

345
Be sure to add `.col-form-label` to your `<label>`s as well so they're vertically centered with their associated form controls. For `<legend>` elements, you can use `.col-form-legend` to make them appear similar to regular `<label>` elements.
Mark Otto's avatar
Mark Otto committed
346
347

{% example html %}
348
349
350
<div class="container">
  <form>
    <div class="form-group row">
351
      <label for="inputEmail3" class="col-sm-2 col-form-label">Email</label>
352
353
354
      <div class="col-sm-10">
        <input type="email" class="form-control" id="inputEmail3" placeholder="Email">
      </div>
Mark Otto's avatar
Mark Otto committed
355
    </div>
356
    <div class="form-group row">
357
      <label for="inputPassword3" class="col-sm-2 col-form-label">Password</label>
358
359
360
      <div class="col-sm-10">
        <input type="password" class="form-control" id="inputPassword3" placeholder="Password">
      </div>
Mark Otto's avatar
Mark Otto committed
361
    </div>
362
    <fieldset class="form-group row">
363
      <legend class="col-form-legend col-sm-2">Radios</legend>
364
      <div class="col-sm-10">
365
366
367
        <div class="form-check">
          <label class="form-check-label">
            <input class="form-check-input" type="radio" name="gridRadios" id="gridRadios1" value="option1" checked>
368
369
370
            Option one is this and that&mdash;be sure to include why it's great
          </label>
        </div>
371
372
373
        <div class="form-check">
          <label class="form-check-label">
            <input class="form-check-input" type="radio" name="gridRadios" id="gridRadios2" value="option2">
374
375
376
            Option two can be something else and selecting it will deselect option one
          </label>
        </div>
377
378
379
        <div class="form-check disabled">
          <label class="form-check-label">
            <input class="form-check-input" type="radio" name="gridRadios" id="gridRadios3" value="option3" disabled>
380
381
382
            Option three is disabled
          </label>
        </div>
383
      </div>
384
    </fieldset>
385
386
387
    <div class="form-group row">
      <label class="col-sm-2">Checkbox</label>
      <div class="col-sm-10">
388
389
390
        <div class="form-check">
          <label class="form-check-label">
            <input class="form-check-input" type="checkbox"> Check me out
391
392
          </label>
        </div>
393
      </div>
394
395
    </div>
    <div class="form-group row">
396
397
      <div class="offset-sm-2 col-sm-10">
        <button type="submit" class="btn btn-primary">Sign in</button>
398
399
      </div>
    </div>
400
401
402
403
404
405
406
407
408
409
  </form>
</div>
{% endexample %}

Grid-based form layouts also support large and small inputs.

{% example html %}
<div class="container">
  <form>
    <div class="form-group row">
410
      <label for="lgFormGroupInput" class="col-sm-2 col-form-label col-form-label-lg">Email</label>
411
412
      <div class="col-sm-10">
        <input type="email" class="form-control form-control-lg" id="lgFormGroupInput" placeholder="you@example.com">
Mark Otto's avatar
Mark Otto committed
413
      </div>
414
    </div>
415
    <div class="form-group row">
416
      <label for="smFormGroupInput" class="col-sm-2 col-form-label col-form-label-sm">Email</label>
417
418
419
      <div class="col-sm-10">
        <input type="email" class="form-control form-control-sm" id="smFormGroupInput" placeholder="you@example.com">
      </div>
Mark Otto's avatar
Mark Otto committed
420
    </div>
421
422
  </form>
</div>
Mark Otto's avatar
Mark Otto committed
423
{% endexample %}
Mark Otto's avatar
Mark Otto committed
424

425

426
## Checkboxes and radios
Mark Otto's avatar
Mark Otto committed
427

Mark Otto's avatar
Mark Otto committed
428
Default checkboxes and radios are improved upon with the help of `.form-check`, **a single class for both input types that improves the layout and behavior of their HTML elements**. Checkboxes are for selecting one or several options in a list, while radios are for selecting one option from many.
Mark Otto's avatar
Mark Otto committed
429

430
Disabled checkboxes and radios are supported, but to provide a `not-allowed` cursor on hover of the parent `<label>`, you'll need to add the `.disabled` class to the parent `.form-check`. The disabled class will also lighten the text color to help indicate the input's state.
Mark Otto's avatar
Mark Otto committed
431

432
### Default (stacked)
Mark Otto's avatar
Mark Otto committed
433

434
435
By default, any number of checkboxes and radios that are immediate sibling will be vertically stacked and appropriately spaced with `.form-check`.

Mark Otto's avatar
Mark Otto committed
436
{% example html %}
Mark Otto's avatar
Mark Otto committed
437
438
439
<div class="form-check">
  <label class="form-check-label">
    <input class="form-check-input" type="checkbox" value="">
Mark Otto's avatar
Mark Otto committed
440
441
442
    Option one is this and that&mdash;be sure to include why it's great
  </label>
</div>
Mark Otto's avatar
Mark Otto committed
443
444
445
<div class="form-check disabled">
  <label class="form-check-label">
    <input class="form-check-input" type="checkbox" value="" disabled>
Chris Rebert's avatar
Chris Rebert committed
446
447
448
    Option two is disabled
  </label>
</div>
449
{% endexample %}
Mark Otto's avatar
Mark Otto committed
450

451
{% example html %}
Mark Otto's avatar
Mark Otto committed
452
453
454
<div class="form-check">
  <label class="form-check-label">
    <input class="form-check-input" type="radio" name="exampleRadios" id="exampleRadios1" value="option1" checked>
Mark Otto's avatar
Mark Otto committed
455
456
457
    Option one is this and that&mdash;be sure to include why it's great
  </label>
</div>
Mark Otto's avatar
Mark Otto committed
458
459
460
<div class="form-check">
  <label class="form-check-label">
    <input class="form-check-input" type="radio" name="exampleRadios" id="exampleRadios2" value="option2">
Mark Otto's avatar
Mark Otto committed
461
462
463
    Option two can be something else and selecting it will deselect option one
  </label>
</div>
Mark Otto's avatar
Mark Otto committed
464
465
466
<div class="form-check disabled">
  <label class="form-check-label">
    <input class="form-check-input" type="radio" name="exampleRadios" id="exampleRadios3" value="option3" disabled>
Chris Rebert's avatar
Chris Rebert committed
467
468
469
    Option three is disabled
  </label>
</div>
Mark Otto's avatar
Mark Otto committed
470
{% endexample %}
Mark Otto's avatar
Mark Otto committed
471

472
### Inline
Mark Otto's avatar
Mark Otto committed
473

Mark Otto's avatar
Mark Otto committed
474
Groups of checkboxes or radios that appear on the same horizontal row are similar to their stacked counterparts, but require different HTML and a single class. To switch from stacked to inline, drop the surrounding `<div>`, add `.form-check-inline` to the `<label>`, and keep the `.form-check-input` on the `<input>`.
Mark Otto's avatar
Mark Otto committed
475
476

{% example html %}
Mark Otto's avatar
Mark Otto committed
477
478
<label class="form-check-inline">
  <input class="form-check-input" type="checkbox" id="inlineCheckbox1" value="option1"> 1
Mark Otto's avatar
Mark Otto committed
479
</label>
Mark Otto's avatar
Mark Otto committed
480
481
<label class="form-check-inline">
  <input class="form-check-input" type="checkbox" id="inlineCheckbox2" value="option2"> 2
Mark Otto's avatar
Mark Otto committed
482
</label>
Mark Otto's avatar
Mark Otto committed
483
484
<label class="form-check-inline">
  <input class="form-check-input" type="checkbox" id="inlineCheckbox3" value="option3"> 3
Mark Otto's avatar
Mark Otto committed
485
</label>
486
{% endexample %}
Mark Otto's avatar
Mark Otto committed
487

488
{% example html %}
Mark Otto's avatar
Mark Otto committed
489
490
<label class="form-check-inline">
  <input class="form-check-input" type="radio" name="inlineRadioOptions" id="inlineRadio1" value="option1"> 1
Mark Otto's avatar
Mark Otto committed
491
</label>
Mark Otto's avatar
Mark Otto committed
492
493
<label class="form-check-inline">
  <input class="form-check-input" type="radio" name="inlineRadioOptions" id="inlineRadio2" value="option2"> 2
Mark Otto's avatar
Mark Otto committed
494
</label>
Mark Otto's avatar
Mark Otto committed
495
496
<label class="form-check-inline">
  <input class="form-check-input" type="radio" name="inlineRadioOptions" id="inlineRadio3" value="option3"> 3
Mark Otto's avatar
Mark Otto committed
497
</label>
Mark Otto's avatar
Mark Otto committed
498
{% endexample %}
Mark Otto's avatar
Mark Otto committed
499

500
### Without labels
Mark Otto's avatar
Mark Otto committed
501

502
Should you have no text within the `<label>`, the input is positioned as you'd expect. **Currently only works on non-inline checkboxes and radios.** Remember to still provide some form of label for assistive technologies (for instance, using `aria-label`).
Mark Otto's avatar
Mark Otto committed
503
504

{% example html %}
Mark Otto's avatar
Mark Otto committed
505
506
507
<div class="form-check">
  <label class="form-check-label">
    <input class="form-check-input" type="checkbox" id="blankCheckbox" value="option1" aria-label="...">
Mark Otto's avatar
Mark Otto committed
508
509
  </label>
</div>
Mark Otto's avatar
Mark Otto committed
510
511
512
<div class="form-check">
  <label class="form-check-label">
    <input class="form-check-input" type="radio" name="blankRadio" id="blankRadio1" value="option1" aria-label="...">
Mark Otto's avatar
Mark Otto committed
513
514
515
516
  </label>
</div>
{% endexample %}

Mark Otto's avatar
Mark Otto committed
517
## Static controls
Mark Otto's avatar
Mark Otto committed
518

Mark Otto's avatar
Mark Otto committed
519
When you need to place plain text next to a form label within a form, use the `.form-control-static` class on an element of your choice. Using an element like `<p>` with a default margin? Be sure to use a margin override (as shown below).
Mark Otto's avatar
Mark Otto committed
520
521

{% example html %}
522
<form>
523
  <div class="form-group row">
524
    <label class="col-sm-2 col-form-label">Email</label>
Mark Otto's avatar
Mark Otto committed
525
    <div class="col-sm-10">
Mark Otto's avatar
Mark Otto committed
526
      <p class="form-control-static mb-0">email@example.com</p>
Mark Otto's avatar
Mark Otto committed
527
528
    </div>
  </div>
529
  <div class="form-group row">
530
    <label for="inputPassword" class="col-sm-2 col-form-label">Password</label>
Mark Otto's avatar
Mark Otto committed
531
532
533
534
535
    <div class="col-sm-10">
      <input type="password" class="form-control" id="inputPassword" placeholder="Password">
    </div>
  </div>
</form>
Mark Otto's avatar
Mark Otto committed
536
{% endexample %}
Mark Otto's avatar
Mark Otto committed
537

Mark Otto's avatar
Mark Otto committed
538
{% example html %}
Mark Otto's avatar
Mark Otto committed
539
<form class="form-inline">
Mark Otto's avatar
Mark Otto committed
540
541
542
543
544
545
546
547
  <div class="form-group">
    <label class="sr-only">Email</label>
    <p class="form-control-static">email@example.com</p>
  </div>
  <div class="form-group">
    <label for="inputPassword2" class="sr-only">Password</label>
    <input type="password" class="form-control" id="inputPassword2" placeholder="Password">
  </div>
Mark Otto's avatar
Mark Otto committed
548
  <button type="submit" class="btn btn-primary">Confirm identity</button>
Mark Otto's avatar
Mark Otto committed
549
550
551
</form>
{% endexample %}

Mark Otto's avatar
Mark Otto committed
552
## Disabled states
Mark Otto's avatar
Mark Otto committed
553

Mark Otto's avatar
Mark Otto committed
554
Add the `disabled` boolean attribute on an input to prevent user interactions. Disabled inputs appear lighter and add a `not-allowed` cursor.
Mark Otto's avatar
Mark Otto committed
555
556

{% highlight html %}
Mark Otto's avatar
Mark Otto committed
557
558
559
560
561
562
<input class="form-control" id="disabledInput" type="text" placeholder="Disabled input here..." disabled>
{% endhighlight %}

Add the `disabled` attribute to a `<fieldset>` to disable all the controls within.

{% example html %}
Mark Otto's avatar
Mark Otto committed
563
<form>
Mark Otto's avatar
Mark Otto committed
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
  <fieldset disabled>
    <div class="form-group">
      <label for="disabledTextInput">Disabled input</label>
      <input type="text" id="disabledTextInput" class="form-control" placeholder="Disabled input">
    </div>
    <div class="form-group">
      <label for="disabledSelect">Disabled select menu</label>
      <select id="disabledSelect" class="form-control">
        <option>Disabled select</option>
      </select>
    </div>
    <div class="checkbox">
      <label>
        <input type="checkbox"> Can't check this
      </label>
    </div>
    <button type="submit" class="btn btn-primary">Submit</button>
  </fieldset>
</form>
Mark Otto's avatar
Mark Otto committed
583
{% endexample %}
Mark Otto's avatar
Mark Otto committed
584

585
586
{% callout warning %}
#### Caveat about link functionality of `<a>`
Mark Otto's avatar
Mark Otto committed
587

588
By default, browsers will treat all native form controls (`<input>`, `<select>` and `<button>` elements) inside a `<fieldset disabled>` as disabled, preventing both keyboard and mouse interactions on them. However, if your form also includes `<a ... class="btn btn-*">` elements, these will only be given a style of `pointer-events: none`. As noted in the section about [disabled state for buttons]({{ site.baseurl }}/buttons/#disabled-state) (and specifically in the sub-section for anchor elements), this CSS property is not yet standardized and isn't fully supported in Opera 18 and below, or in Internet Explorer 11, and won't prevent keyboard users from being able to focus or activate these links. So to be safe, use custom JavaScript to disable such links.
589
590
591
592
593
594
595
{% endcallout %}

{% callout danger %}
#### Cross-browser compatibility

While Bootstrap will apply these styles in all browsers, Internet Explorer 11 and below don't fully support the `disabled` attribute on a `<fieldset>`. Use custom JavaScript to disable the fieldset in these browsers.
{% endcallout %}
Mark Otto's avatar
Mark Otto committed
596
597
598

## Readonly inputs

599
Add the `readonly` boolean attribute on an input to prevent modification of the input's value. Read-only inputs appear lighter (just like disabled inputs), but retain the standard cursor.
Mark Otto's avatar
Mark Otto committed
600
601

{% example html %}
Mark Otto's avatar
Mark Otto committed
602
<input class="form-control" type="text" placeholder="Readonly input here…" readonly>
Mark Otto's avatar
Mark Otto committed
603
{% endexample %}
Mark Otto's avatar
Mark Otto committed
604

Mark Otto's avatar
Mark Otto committed
605
606
607
608
609
## Control sizing

Set heights using classes like `.form-control-lg`, and set widths using grid column classes like `.col-lg-*`.

{% example html %}
610
<input class="form-control form-control-lg" type="text" placeholder=".form-control-lg">
Mark Otto's avatar
Mark Otto committed
611
<input class="form-control" type="text" placeholder="Default input">
612
<input class="form-control form-control-sm" type="text" placeholder=".form-control-sm">
Mark Otto's avatar
Mark Otto committed
613
614
615
{% endexample %}

{% example html %}
616
617
618
619
620
621
622
623
624
<select class="form-control form-control-lg">
  <option>Large select</option>
</select>
<select class="form-control">
  <option>Default select</option>
</select>
<select class="form-control form-control-sm">
  <option>Small select</option>
</select>
Mark Otto's avatar
Mark Otto committed
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
{% endexample %}

## Column sizing

Wrap inputs in grid columns, or any custom parent element, to easily enforce desired widths.

{% example html %}
<div class="row">
  <div class="col-xs-2">
    <input type="text" class="form-control" placeholder=".col-xs-2">
  </div>
  <div class="col-xs-3">
    <input type="text" class="form-control" placeholder=".col-xs-3">
  </div>
  <div class="col-xs-4">
    <input type="text" class="form-control" placeholder=".col-xs-4">
  </div>
</div>
{% endexample %}

## Help text

647
Block-level help text in forms can be created using `.form-text` (previously known as `.help-block` in v3). Inline help text can be flexibly implemented using any inline HTML element and utility classes like `.text-muted`.
Mark Otto's avatar
Mark Otto committed
648

649
650
651
652
653
654
{% callout warning %}
#### Associating help text with form controls

Help text should be explicitly associated with the form control it relates to using the `aria-describedby` attribute. This will ensure that assistive technologies – such as screen readers – will announce this help text when the user focuses or enters the control.
{% endcallout %}

655
656
657
658
659
660
661
662
663
664
665
666
667
668
### Block level

Block help text—for below inputs or for longer lines of help text—can be easily achieved with `.form-text`. This class includes `display: block` and adds some top margin for easy spacing from the inputs above.

{% example html %}
<label for="inputPassword5">Password</label>
<input type="password" id="inputPassword5" class="form-control" aria-describedby="passwordHelpBlock">
<p id="passwordHelpBlock" class="form-text text-muted">
  Your password must be 8-20 characters long, contain letters and numbers, and must not contain spaces, special characters, or emoji.
</p>
{% endexample %}

### Inline

Mark Otto's avatar
Mark Otto committed
669
Inline text can use any typical inline HTML element (be it a `<small>`, `<span>`, or something else).
Mark Otto's avatar
Mark Otto committed
670
671

{% example html %}
672
673
674
675
676
677
678
679
680
<form class="form-inline">
  <div class="form-group">
    <label for="inputPassword4">Password</label>
    <input type="password" id="inputPassword4" class="form-control" aria-describedby="passwordHelpInline">
    <small id="passwordHelpInline" class="text-muted">
      Must be 8-20 characters long.
    </small>
  </div>
</form>
681
682
{% endexample %}

Mark Otto's avatar
Mark Otto committed
683
## Validation
Mark Otto's avatar
Mark Otto committed
684

Mark Otto's avatar
Mark Otto committed
685
Bootstrap includes validation styles for danger, warning, and success states on form controls. Here's a rundown of how they work:
686

687
- To use, add `.has-warning`, `.has-danger`, or `.has-success` to the parent element. Any `.col-form-label`, `.form-control`, or custom form element will receive the validation styles.
688
- Contextual validation text, in addition to your usual form field help text, can be added with the use of `.form-control-feedback`. This text will adapt to the parent `.has-*` class. By default it only includes a bit of `margin` for spacing and a modified `color` for each state.
689
690
- Validation icons are `url()`s configured via Sass variables that are applied to `background-image` declarations for each state.
- You may use your own base64 PNGs or SVGs by updating the Sass variables and recompiling.
691
- Icons can also be disabled entirely by setting the variables to `none` or commenting out the source Sass.
Mark Otto's avatar
Mark Otto committed
692

Mark Otto's avatar
Mark Otto committed
693
694
695
696
697
698
699
700
Generally speaking, you'll want to use a particular state for specific types of feedback:

- **Danger** is great for when there's a blocking or required field. A user *must* fill in this field properly to submit the form.
- **Warning** works well for input values that are in progress, like password strength, or soft validation before a user attempts to submit a form.
- And lastly, **success** is ideal for situations when you have per-field validation throughout a form and want to encourage a user through the rest of the fields.

Here are some examples of the aforementioned classes in action.

701
{% comment %}
702
703
704
705
706
{% callout warning %}
#### Conveying validation state to assistive technologies and colorblind users

Using these validation styles to denote the state of a form control only provides a visual, color-based indication, which will not be conveyed to users of assistive technologies - such as screen readers - or to colorblind users.

707
Ensure that an alternative indication of state is also provided. For instance, you can include a hint about state in the form control's `<label>` text itself (as is the case in the following code example), include a [Glyphicon]({{ site.baseurl }}/components/#glyphicons) (with appropriate alternative text using the `.sr-only` class - see the [Glyphicon examples]({{ site.baseurl }}/components/#glyphicons-examples)), or by providing an additional [help text](#forms-help-text) block. Specifically for assistive technologies, invalid form controls can also be assigned an `aria-invalid="true"` attribute.
708
{% endcallout %}
709
{% endcomment %}
Mark Otto's avatar
Mark Otto committed
710

Mark Otto's avatar
Mark Otto committed
711
{% example html %}
Mark Otto's avatar
Mark Otto committed
712
<div class="form-group has-success">
713
  <label class="col-form-label" for="inputSuccess1">Input with success</label>
714
  <input type="text" class="form-control form-control-success" id="inputSuccess1">
Mark Otto's avatar
Mark Otto committed
715
  <div class="form-control-feedback">Success! You've done it.</div>
716
  <small class="form-text text-muted">Example help text that remains unchanged.</small>
Mark Otto's avatar
Mark Otto committed
717
718
</div>
<div class="form-group has-warning">
719
  <label class="col-form-label" for="inputWarning1">Input with warning</label>
720
  <input type="text" class="form-control form-control-warning" id="inputWarning1">
Mark Otto's avatar
Mark Otto committed
721
  <div class="form-control-feedback">Shucks, check the formatting of that and try again.</div>
722
  <small class="form-text text-muted">Example help text that remains unchanged.</small>
Mark Otto's avatar
Mark Otto committed
723
</div>
724
<div class="form-group has-danger">
725
  <label class="col-form-label" for="inputDanger1">Input with danger</label>
Mark Otto's avatar
Mark Otto committed
726
  <input type="text" class="form-control form-control-danger" id="inputDanger1">
727
  <div class="form-control-feedback">Sorry, that username's taken. Try another?</div>
728
  <small class="form-text text-muted">Example help text that remains unchanged.</small>
Mark Otto's avatar
Mark Otto committed
729
</div>
Mark Otto's avatar
Mark Otto committed
730
{% endexample %}
731

Mark Otto's avatar
Mark Otto committed
732
{% example html %}
733
734
735
<div class="form-check has-success">
  <label class="form-check-label">
    <input type="checkbox" class="form-check-input" id="checkboxSuccess" value="option1">
736
737
    Checkbox with success
  </label>
738
</div>
739
740
741
<div class="form-check has-warning">
  <label class="form-check-label">
    <input type="checkbox" class="form-check-input" id="checkboxWarning" value="option1">
742
743
    Checkbox with warning
  </label>
Mark Otto's avatar
Mark Otto committed
744
</div>
745
746
747
<div class="form-check has-danger">
  <label class="form-check-label">
    <input type="checkbox" class="form-check-input" id="checkboxDanger" value="option1">
Mark Otto's avatar
Mark Otto committed
748
    Checkbox with danger
749
  </label>
750
</div>
Mark Otto's avatar
Mark Otto committed
751
{% endexample %}
Mark Otto's avatar
Mark Otto committed
752

753
754
## Custom forms

755
For even more customization and cross browser consistency, use our completely custom form elements to replace the browser defaults. They're built on top of semantic and accessible markup, so they're solid replacements for any default form control.
756
757
758
759
760
761
762
763
764

### Checkboxes and radios

Each checkbox and radio is wrapped in a `<label>` for three reasons:

- It provides a larger hit areas for checking the control.
- It provides a helpful and semantic wrapper to help us replace the default `<input>`s.
- It triggers the state of the `<input>` automatically, meaning no JavaScript is required.

Mark Otto's avatar
Mark Otto committed
765
We hide the default `<input>` with `opacity` and use the `.custom-control-indicator` to build a new custom form indicator in its place. Unfortunately we can't build a custom one from just the `<input>` because CSS's `content` doesn't work on that element.
766

Mark Otto's avatar
Mark Otto committed
767
We use the sibling selector (`~`) for all our `<input>` states—like `:checked`—to properly style our custom form indicator. When combined with the `.custom-control-description` class, we can also style the text for each item based on the `<input>`'s state.
768

XhmikosR's avatar
XhmikosR committed
769
In the checked states, we use **base64 embedded SVG icons** from [Open Iconic](https://useiconic.com/open). This provides us the best control for styling and positioning across browsers and devices.
770
771
772
773

#### Checkboxes

{% example html %}
Mark Otto's avatar
Mark Otto committed
774
775
776
777
<label class="custom-control custom-checkbox">
  <input type="checkbox" class="custom-control-input">
  <span class="custom-control-indicator"></span>
  <span class="custom-control-description">Check this custom checkbox</span>
778
779
780
</label>
{% endexample %}

781
Custom checkboxes can also utilize the `:indeterminate` pseudo class when manually set via JavaScript (there is no available HTML attribute for specifying it).
782
783

<div class="bd-example bd-example-indeterminate">
Mark Otto's avatar
Mark Otto committed
784
785
786
787
  <label class="custom-control custom-checkbox">
    <input type="checkbox" class="custom-control-input">
    <span class="custom-control-indicator"></span>
    <span class="custom-control-description">Check this custom checkbox</span>
788
789
790
  </label>
</div>

Mark Otto's avatar
Mark Otto committed
791
If you're using jQuery, something like this should suffice:
792
793
794
795
796
797
798
799

{% highlight js %}
$('.your-checkbox').prop('indeterminate', true)
{% endhighlight %}

#### Radios

{% example html %}
Mark Otto's avatar
Mark Otto committed
800
801
802
803
<label class="custom-control custom-radio">
  <input id="radio1" name="radio" type="radio" class="custom-control-input">
  <span class="custom-control-indicator"></span>
  <span class="custom-control-description">Toggle this custom radio</span>
804
</label>
Mark Otto's avatar
Mark Otto committed
805
806
807
808
<label class="custom-control custom-radio">
  <input id="radio2" name="radio" type="radio" class="custom-control-input">
  <span class="custom-control-indicator"></span>
  <span class="custom-control-description">Or toggle this other custom radio</span>
809
810
811
</label>
{% endexample %}

Mark Otto's avatar
Mark Otto committed
812
813
#### Disabled

Mark Otto's avatar
Mark Otto committed
814
Custom checkboxes and radios can also be disabled. Add the `disabled` boolean attribute to the `<input>` and the custom indicator and label description will be automatically styled.
Mark Otto's avatar
Mark Otto committed
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829

{% example html %}
<label class="custom-control custom-checkbox">
  <input type="checkbox" class="custom-control-input" disabled>
  <span class="custom-control-indicator"></span>
  <span class="custom-control-description">Check this custom checkbox</span>
</label>

<label class="custom-control custom-radio">
  <input id="radio3" name="radioDisabled" type="radio" class="custom-control-input" disabled>
  <span class="custom-control-indicator"></span>
  <span class="custom-control-description">Toggle this custom radio</span>
</label>
{% endexample %}

830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
#### Validation states

Add other states to your custom forms with our validation classes.

{% example html %}
<div class="form-group has-success">
  <label class="custom-control custom-checkbox">
    <input type="checkbox" class="custom-control-input">
    <span class="custom-control-indicator"></span>
    <span class="custom-control-description">Check this custom checkbox</span>
  </label>
</div>
<div class="form-group has-warning">
  <label class="custom-control custom-checkbox">
    <input type="checkbox" class="custom-control-input">
    <span class="custom-control-indicator"></span>
    <span class="custom-control-description">Check this custom checkbox</span>
  </label>
</div>
849
<div class="form-group has-danger mb-0">
850
851
852
853
854
855
856
  <label class="custom-control custom-checkbox">
    <input type="checkbox" class="custom-control-input">
    <span class="custom-control-indicator"></span>
    <span class="custom-control-description">Check this custom checkbox</span>
  </label>
</div>
{% endexample %}
Mark Otto's avatar
Mark Otto committed
857

858
859
#### Stacked

Mark Otto's avatar
Mark Otto committed
860
Custom checkboxes and radios are inline to start. Add a parent with class `.custom-controls-stacked` to ensure each form control is on separate lines.
861
862

{% example html %}
Mark Otto's avatar
Mark Otto committed
863
864
865
866
867
<div class="custom-controls-stacked">
  <label class="custom-control custom-radio">
    <input id="radioStacked1" name="radio-stacked" type="radio" class="custom-control-input">
    <span class="custom-control-indicator"></span>
    <span class="custom-control-description">Toggle this custom radio</span>
868
  </label>
Mark Otto's avatar
Mark Otto committed
869
870
871
872
  <label class="custom-control custom-radio">
    <input id="radioStacked2" name="radio-stacked" type="radio" class="custom-control-input">
    <span class="custom-control-indicator"></span>
    <span class="custom-control-description">Or toggle this other custom radio</span>
873
874
875
876
877
878
  </label>
</div>
{% endexample %}

### Select menu

879
Custom `<select>` menus need only a custom class, `.custom-select` to trigger the custom styles.
880
881

{% example html %}
882
<select class="custom-select">
883
884
885
886
887
  <option selected>Open this select menu</option>
  <option value="1">One</option>
  <option value="2">Two</option>
  <option value="3">Three</option>
</select>
888
889
{% endexample %}

890
Custom selects degrade nicely in IE9, receiving only a handful of overrides to remove the custom `background-image`. **Multiple selects (e.g., `<select multiple>`) are not currently supported.**
891
892
893

### File browser

894
895
The file input is the most gnarly of the bunch and require additional JavaScript if you'd like to hook them up with functional *Choose file...* and selected file name text.

896
{% example html %}
897
898
899
<label class="custom-file">
  <input type="file" id="file" class="custom-file-input">
  <span class="custom-file-control"></span>
900
901
902
</label>
{% endexample %}

903
Here's how it works:
904
905
906
907
908
909
910
911

- We wrap the `<input>` in a `<label>` so the custom control properly triggers the file browser.
- We hide the default file `<input>` via `opacity`.
- We use `:after` to generate a custom background and directive (*Choose file...*).
- We use `:before` to generate and position the *Browse* button.
- We declare a `height` on the `<input>` for proper spacing for surrounding content.

In other words, it's an entirely custom element, all generated via CSS.
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930

#### Translating or customizing the strings

The [`:lang()` pseudo-class](https://developer.mozilla.org/en-US/docs/Web/CSS/:lang) is used to allow for easy translation of the "Browse" and "Choose file..." text into other languages. Simply override or add entries to the `$custom-file-text` SCSS variable with the relevant [language tag](https://en.wikipedia.org/wiki/IETF_language_tag) and localized strings. The English strings can be customized the same way. For example, here's how one might add a Spanish translation (Spanish's language code is `es`):

{% highlight scss %}
$custom-file-text: (
  placeholder: (
    en: "Choose file...",
    es: "Seleccionar archivo..."
  ),
  button-label: (
    en: "Browse",
    es: "Navegar"
  )
);
{% endhighlight %}

You'll need to set the language of your document (or subtree thereof) correctly in order for the correct text to be shown. This can be done using [the `lang` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/lang) or the [`Content-Language` HTTP header](https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.12), among other methods.