forms.md 52.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 form control styles, layout options, and custom components for creating a wide variety of forms.
5
group: components
Mark Otto's avatar
Mark Otto committed
6
toc: true
Mark Otto's avatar
Mark Otto committed
7
8
---

9
## Form controls
Mark Otto's avatar
Mark Otto committed
10

Mark Otto's avatar
Mark Otto committed
11
Bootstrap's form controls expand on [our Rebooted form styles]({{ site.baseurl }}/docs/{{ site.docs_version }}/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
12

13
Be sure to use an appropriate `type` attribute on all inputs (e.g., `email` for email address or `number` for numerical information).
14

15
16
### Example

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

88
89
### Supported controls

90
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.
91
92
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

<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>
120
        {% markdown %}`text`, `password`, `datetime-local`, `date`, `month`, `time`, `week`, `number`, `email`, `url`, `search`, `tel`, `color`{% endmarkdown %}
121
122
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
      </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 %}
153
`.form-check`
154
155
156
157
158
159
160
161
162
163
164
165
{% endmarkdown %}
      </td>
      <td class="text-nowrap">
        Checkboxes and radios
      </td>
      <td>
        <span class="text-muted">N/A</span>
      </td>
    </tr>
  </tbody>
</table>

166
167
### Textual inputs

168
Here are examples of `.form-control` applied to each textual HTML5 `<input>` `type` (meaning, almost everything except the file, checkbox, and radio inputs).
169

170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
| Type | Example |
| --- | --- |
| `text` | <input class="form-control" type="text" value="Artisanal kale" id="example-text-input"> |
| `search` | <input class="form-control" type="search" value="How do I shoot web" id="example-search-input"> |
| `email` | <input class="form-control" type="email" value="bootstrap@example.com" id="example-email-input"> |
| `url` | <input class="form-control" type="url" value="https://getbootstrap.com" id="example-url-input"> |
| `tel` | <input class="form-control" type="tel" value="1-(555)-555-5555" id="example-tel-input"> |
| `password` | <input class="form-control" type="password" value="hunter2" id="example-password-input"> |
| `number` | <input class="form-control" type="number" value="42" id="example-number-input"> |
| `datetime-local` | <input class="form-control" type="datetime-local" value="2011-08-19T13:45:00" id="example-datetime-local-input"> |
| `date` | <input class="form-control" type="date" value="2011-08-19" id="example-date-input"> |
| `month` | <input class="form-control" type="month" value="2011-08" id="example-month-input"> |
| `week` | <input class="form-control" type="week" value="2011-W33" id="example-week-input"> |
| `time` | <input class="form-control" type="time" value="13:45:00" id="example-time-input"> |
| `color` | <input class="form-control" type="color" value="#563d7c" id="example-color-input"> |
185

Mark Otto's avatar
Mark Otto committed
186
## Layout
187
188
189
190
191

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

192
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
193

194
195
{% example html %}
<form>
196
  <div class="form-group">
Mark Otto's avatar
Mark Otto committed
197
    <label class="form-control-label" for="formGroupExampleInput">Example label</label>
198
    <input type="text" class="form-control" id="formGroupExampleInput" placeholder="Example input">
199
200
  </div>
  <div class="form-group">
Mark Otto's avatar
Mark Otto committed
201
    <label class="form-control-label" for="formGroupExampleInput2">Another label</label>
202
    <input type="text" class="form-control" id="formGroupExampleInput2" placeholder="Another input">
203
  </div>
204
205
206
</form>
{% endexample %}

207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
### Grid

{% example html %}
<form>
  <div class="row gutters-sm">
    <div class="col">
      <input type="text" class="form-control" placeholder="First name">
    </div>
    <div class="col">
      <input type="text" class="form-control" placeholder="Last name">
    </div>
  </div>
</form>
{% endexample html %}

{% example html %}
<form>
  <div class="row gutters-sm">
    <div class="col-7">
      <input type="text" class="form-control" placeholder="City">
    </div>
    <div class="col">
      <input type="text" class="form-control" placeholder="State">
    </div>
    <div class="col">
      <input type="text" class="form-control" placeholder="Zip">
    </div>
  </div>
</form>
{% endexample html %}

{% example html %}
<form>
  <div class="row gutters-sm align-items-center">
    <div class="col">
      <label class="sr-only" for="inlineFormInput">Name</label>
      <input type="text" class="form-control mb-2 mb-sm-0" id="inlineFormInput" placeholder="Jane Doe">
    </div>
    <div class="col">
      <label class="sr-only" for="inlineFormInputGroup">Username</label>
      <div class="input-group mb-2 mb-sm-0">
        <div class="input-group-addon">@</div>
        <input type="text" class="form-control" id="inlineFormInputGroup" placeholder="Username">
      </div>
    </div>
    <div class="col">
      <div class="form-check mb-2 mb-sm-0">
        <label class="form-check-label">
          <input class="form-check-input" type="checkbox"> Remember me
        </label>
      </div>
    </div>
    <div class="col">
      <button type="submit" class="btn btn-primary">Submit</button>
    </div>
  </div>
</form>
{% endexample %}

{% example html %}
<form>
  <div class="row gutters-sm align-items-center">
    <div class="col-auto">
      <label class="sr-only" for="inlineFormInput">Name</label>
      <input type="text" class="form-control mb-2 mb-sm-0" id="inlineFormInput" placeholder="Jane Doe">
    </div>
    <div class="col-auto">
      <label class="sr-only" for="inlineFormInputGroup">Username</label>
      <div class="input-group mb-2 mb-sm-0">
        <div class="input-group-addon">@</div>
        <input type="text" class="form-control" id="inlineFormInputGroup" placeholder="Username">
      </div>
    </div>
    <div class="col-auto">
      <div class="form-check mb-2 mb-sm-0">
        <label class="form-check-label">
          <input class="form-check-input" type="checkbox"> Remember me
        </label>
      </div>
    </div>
    <div class="col-auto">
      <button type="submit" class="btn btn-primary">Submit</button>
    </div>
  </div>
</form>
{% endexample %}

{% example html %}
<form>
  <div class="row gutters-sm align-items-center">
    <div class="col-sm-3">
      <label class="sr-only" for="inlineFormInput">Name</label>
      <input type="text" class="form-control mb-2 mb-sm-0" id="inlineFormInput" placeholder="Jane Doe">
    </div>
    <div class="col-sm-3">
      <label class="sr-only" for="inlineFormInputGroup">Username</label>
      <div class="input-group mb-2 mb-sm-0">
        <div class="input-group-addon">@</div>
        <input type="text" class="form-control" id="inlineFormInputGroup" placeholder="Username">
      </div>
    </div>
    <div class="col-auto">
      <div class="form-check mb-2 mb-sm-0">
        <label class="form-check-label">
          <input class="form-check-input" type="checkbox"> Remember me
        </label>
      </div>
    </div>
    <div class="col-auto">
      <button type="submit" class="btn btn-primary">Submit</button>
    </div>
  </div>
</form>
{% endexample %}

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
{% example html %}
<form>
  <div class="row gutters-sm align-items-center">
    <div class="col-auto">
      <label class="mr-sm-2" for="inlineFormCustomSelect">Preference</label>
      <select class="custom-select mb-2 mr-sm-2 mb-sm-0" id="inlineFormCustomSelect">
        <option selected>Choose...</option>
        <option value="1">One</option>
        <option value="2">Two</option>
        <option value="3">Three</option>
      </select>
    </div>
    <div class="col-auto">
      <label class="custom-control custom-checkbox mb-2 mr-sm-2 mb-sm-0">
        <input type="checkbox" class="custom-control-input">
        <span class="custom-control-indicator"></span>
        <span class="custom-control-description">Remember my preference</span>
      </label>
    </div>
    <div class="col-auto">
      <button type="submit" class="btn btn-primary">Submit</button>
    </div>
  </div>
</form>
{% endexample %}

348
349
### Inline forms

350
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 vary slightly from their default states.
351

Mark Otto's avatar
Mark Otto committed
352
- Controls are `display: flex`, collapsing any HTML white space and allowing you to provide alignment control with [spacing]({{ site.baseurl }}/docs/{{ site.docs_version }}/utilities/spacing/) and [flexbox]({{ site.baseurl }}/docs/{{ site.docs_version }}/utilities/flexbox/) utilities.
353
354
- Controls and input groups receive `width: auto` to override the Bootstrap default `width: 100%`.
- Controls **only appear inline in viewports that are at least 576px wide** to account for narrow viewports on mobile devices.
Mark Otto's avatar
Mark Otto committed
355

Mark Otto's avatar
Mark Otto committed
356
You may need to manually address the width and alignment of individual form controls with [spacing utilities]({{ site.baseurl }}/docs/{{ site.docs_version }}/utilities/spacing/) (as shown below). Lastly, be sure to always include a `<label>` with each form control, even if you need to hide it from non-screenreader visitors with `.sr-only`.
Mark Otto's avatar
Mark Otto committed
357
358

{% example html %}
359
<form class="form-inline">
360
361
  <label class="sr-only" for="inlineFormInput">Name</label>
  <input type="text" class="form-control mb-2 mr-sm-2 mb-sm-0" id="inlineFormInput" placeholder="Jane Doe">
Mark Otto's avatar
Mark Otto committed
362

363
364
365
366
  <label class="sr-only" for="inlineFormInputGroup">Username</label>
  <div class="input-group mb-2 mr-sm-2 mb-sm-0">
    <div class="input-group-addon">@</div>
    <input type="text" class="form-control" id="inlineFormInputGroup" placeholder="Username">
Mark Otto's avatar
Mark Otto committed
367
  </div>
368
369

  <div class="form-check mb-2 mr-sm-2 mb-sm-0">
370
371
    <label class="form-check-label">
      <input class="form-check-input" type="checkbox"> Remember me
Mark Otto's avatar
Mark Otto committed
372
373
    </label>
  </div>
374
375

  <button type="submit" class="btn btn-primary">Submit</button>
Mark Otto's avatar
Mark Otto committed
376
377
378
</form>
{% endexample %}

379
380
Custom form controls and selects are also supported.

Mark Otto's avatar
Mark Otto committed
381
382
{% example html %}
<form class="form-inline">
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
  <label class="mr-sm-2" for="inlineFormCustomSelect">Preference</label>
  <select class="custom-select mb-2 mr-sm-2 mb-sm-0" id="inlineFormCustomSelect">
    <option selected>Choose...</option>
    <option value="1">One</option>
    <option value="2">Two</option>
    <option value="3">Three</option>
  </select>

  <label class="custom-control custom-checkbox mb-2 mr-sm-2 mb-sm-0">
    <input type="checkbox" class="custom-control-input">
    <span class="custom-control-indicator"></span>
    <span class="custom-control-description">Remember my preference</span>
  </label>

  <button type="submit" class="btn btn-primary">Submit</button>
Mark Otto's avatar
Mark Otto committed
398
</form>
Mark Otto's avatar
Mark Otto committed
399
{% endexample %}
Mark Otto's avatar
Mark Otto committed
400

401
{% callout warning %}
Mark Otto's avatar
Mark Otto committed
402
403
404
#### 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 %}
405

406
### Using the Grid
Mark Otto's avatar
Mark Otto committed
407

Mark Otto's avatar
Mark Otto committed
408
For more structured form layouts that are also responsive, you can utilize Bootstrap's [predefined grid classes]({{ site.baseurl }}/docs/{{ site.docs_version }}/layout/grid/) or [mixins]({{ site.baseurl }}/docs/{{ site.docs_version }}/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
409

410
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
411
412

{% example html %}
413
414
415
<div class="container">
  <form>
    <div class="form-group row">
416
      <label for="inputEmail3" class="col-sm-2 col-form-label">Email</label>
417
418
419
      <div class="col-sm-10">
        <input type="email" class="form-control" id="inputEmail3" placeholder="Email">
      </div>
Mark Otto's avatar
Mark Otto committed
420
    </div>
421
    <div class="form-group row">
422
      <label for="inputPassword3" class="col-sm-2 col-form-label">Password</label>
423
424
425
      <div class="col-sm-10">
        <input type="password" class="form-control" id="inputPassword3" placeholder="Password">
      </div>
Mark Otto's avatar
Mark Otto committed
426
    </div>
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
    <fieldset class="form-group">
      <div class="row">
        <legend class="col-form-legend col-sm-2">Radios</legend>
        <div class="col-sm-10">
          <div class="form-check">
            <label class="form-check-label">
              <input class="form-check-input" type="radio" name="gridRadios" id="gridRadios1" value="option1" checked>
              Option one is this and that&mdash;be sure to include why it's great
            </label>
          </div>
          <div class="form-check">
            <label class="form-check-label">
              <input class="form-check-input" type="radio" name="gridRadios" id="gridRadios2" value="option2">
              Option two can be something else and selecting it will deselect option one
            </label>
          </div>
          <div class="form-check disabled">
            <label class="form-check-label">
              <input class="form-check-input" type="radio" name="gridRadios" id="gridRadios3" value="option3" disabled>
              Option three is disabled
            </label>
          </div>
449
        </div>
450
      </div>
451
    </fieldset>
452
    <div class="form-group row">
453
      <div class="col-sm-2">Checkbox</div>
454
      <div class="col-sm-10">
455
456
457
        <div class="form-check">
          <label class="form-check-label">
            <input class="form-check-input" type="checkbox"> Check me out
458
459
          </label>
        </div>
460
      </div>
461
462
    </div>
    <div class="form-group row">
463
464
      <div class="offset-sm-2 col-sm-10">
        <button type="submit" class="btn btn-primary">Sign in</button>
465
466
      </div>
    </div>
467
468
469
470
  </form>
</div>
{% endexample %}

Mark Otto's avatar
Mark Otto committed
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
More complex layouts can also be created with the grid system.

{% example html %}
<div class="container">
  <form>
    <div class="row">
      <div class="form-group col-md-6">
        <label for="inputEmail4" class="col-form-label">Email</label>
        <input type="email" class="form-control" id="inputEmail4" placeholder="Email">
      </div>
      <div class="form-group col-md-6">
        <label for="inputPassword4" class="col-form-label">Password</label>
        <input type="password" class="form-control" id="inputPassword4" placeholder="Password">
      </div>
    </div>
    <div class="form-group">
      <label for="inputAddress" class="col-form-label">Address</label>
      <input type="text" class="form-control" id="inputAddress" placeholder="1234 Main St">
    </div>
    <div class="form-group">
      <label for="inputAddress2" class="col-form-label">Address 2</label>
      <input type="text" class="form-control" id="inputAddress2" placeholder="Apartment, studio, or floor">
    </div>
    <div class="row">
      <div class="form-group col-md-6">
        <label for="inputCity" class="col-form-label">City</label>
        <input type="text" class="form-control" id="inputCity">
      </div>
      <div class="form-group col-md-4">
        <label for="inputState" class="col-form-label">State</label>
        <select id="inputState" class="form-control">Choose</select>
      </div>
      <div class="form-group col-md-2">
        <label for="inputZip" class="col-form-label">Zip</label>
        <input type="text" class="form-control" id="inputZip">
      </div>
    </div>
    <div class="form-group">
      <div class="form-check">
        <label class="form-check-label">
          <input class="form-check-input" type="checkbox"> Check me out
        </label>
      </div>
    </div>
    <button type="submit" class="btn btn-primary">Sign in</button>
  </form>
</div>
{% endexample %}

520
521
522
523
524
525
Grid-based form layouts also support large and small inputs.

{% example html %}
<div class="container">
  <form>
    <div class="form-group row">
526
      <label for="lgFormGroupInput" class="col-sm-2 col-form-label col-form-label-lg">Email</label>
527
528
      <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
529
      </div>
530
    </div>
531
    <div class="form-group row">
532
      <label for="smFormGroupInput" class="col-sm-2 col-form-label col-form-label-sm">Email</label>
533
534
535
      <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
536
    </div>
537
538
  </form>
</div>
Mark Otto's avatar
Mark Otto committed
539
{% endexample %}
Mark Otto's avatar
Mark Otto committed
540

541
## Checkboxes and radios
Mark Otto's avatar
Mark Otto committed
542

Mark Otto's avatar
Mark Otto committed
543
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
544

545
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
546

547
### Default (stacked)
Mark Otto's avatar
Mark Otto committed
548

549
550
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
551
{% example html %}
Mark Otto's avatar
Mark Otto committed
552
553
554
<div class="form-check">
  <label class="form-check-label">
    <input class="form-check-input" type="checkbox" value="">
Mark Otto's avatar
Mark Otto committed
555
556
557
    Option one is this and that&mdash;be sure to include why it's great
  </label>
</div>
Mark Otto's avatar
Mark Otto committed
558
559
560
<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
561
562
563
    Option two is disabled
  </label>
</div>
564
{% endexample %}
Mark Otto's avatar
Mark Otto committed
565

566
{% example html %}
Mark Otto's avatar
Mark Otto committed
567
568
569
<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
570
571
572
    Option one is this and that&mdash;be sure to include why it's great
  </label>
</div>
Mark Otto's avatar
Mark Otto committed
573
574
575
<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
576
577
578
    Option two can be something else and selecting it will deselect option one
  </label>
</div>
Mark Otto's avatar
Mark Otto committed
579
580
581
<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
582
583
584
    Option three is disabled
  </label>
</div>
Mark Otto's avatar
Mark Otto committed
585
{% endexample %}
Mark Otto's avatar
Mark Otto committed
586

587
### Inline
Mark Otto's avatar
Mark Otto committed
588

589
Group checkboxes or radios on the same horizontal row by adding `.form-check-inline` to any `.form-check`.
Mark Otto's avatar
Mark Otto committed
590
591

{% example html %}
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
<div class="form-check form-check-inline">
  <label class="form-check-label">
    <input class="form-check-input" type="checkbox" id="inlineCheckbox1" value="option1"> 1
  </label>
</div>
<div class="form-check form-check-inline">
  <label class="form-check-label">
    <input class="form-check-input" type="checkbox" id="inlineCheckbox2" value="option2"> 2
  </label>
</div>
<div class="form-check form-check-inline disabled">
  <label class="form-check-label">
    <input class="form-check-input" type="checkbox" id="inlineCheckbox3" value="option3" disabled> 3
  </label>
</div>
607
{% endexample %}
Mark Otto's avatar
Mark Otto committed
608

609
{% example html %}
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
<div class="form-check form-check-inline">
  <label class="form-check-label">
    <input class="form-check-input" type="radio" name="inlineRadioOptions" id="inlineRadio1" value="option1"> 1
  </label>
</div>
<div class="form-check form-check-inline">
  <label class="form-check-label">
    <input class="form-check-input" type="radio" name="inlineRadioOptions" id="inlineRadio2" value="option2"> 2
  </label>
</div>
<div class="form-check form-check-inline disabled">
  <label class="form-check-label">
    <input class="form-check-input" type="radio" name="inlineRadioOptions" id="inlineRadio3" value="option3" disabled> 3
  </label>
</div>
Mark Otto's avatar
Mark Otto committed
625
{% endexample %}
Mark Otto's avatar
Mark Otto committed
626

627
### Without labels
Mark Otto's avatar
Mark Otto committed
628

629
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
630
631

{% example html %}
Mark Otto's avatar
Mark Otto committed
632
633
634
<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
635
636
  </label>
</div>
Mark Otto's avatar
Mark Otto committed
637
638
639
<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
640
641
642
643
  </label>
</div>
{% endexample %}

Mark Otto's avatar
Mark Otto committed
644
## Static controls
Mark Otto's avatar
Mark Otto committed
645

646
If you want to have read-only fields in your form styled as plain text, use the `.form-control-static` class to remove the default form field styling and preserve the correct margin and padding.
Mark Otto's avatar
Mark Otto committed
647
648

{% example html %}
649
<form>
650
  <div class="form-group row">
651
    <label for="staticEmail" class="col-sm-2 col-form-label">Email</label>
Mark Otto's avatar
Mark Otto committed
652
    <div class="col-sm-10">
653
      <input type="text" readonly class="form-control-static" id="staticEmail" value="email@example.com">
Mark Otto's avatar
Mark Otto committed
654
655
    </div>
  </div>
656
  <div class="form-group row">
657
    <label for="inputPassword" class="col-sm-2 col-form-label">Password</label>
Mark Otto's avatar
Mark Otto committed
658
659
660
661
662
    <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
663
{% endexample %}
Mark Otto's avatar
Mark Otto committed
664

Mark Otto's avatar
Mark Otto committed
665
{% example html %}
Mark Otto's avatar
Mark Otto committed
666
<form class="form-inline">
Mark Otto's avatar
Mark Otto committed
667
  <div class="form-group">
668
669
    <label for="staticEmail2" class="sr-only">Email</label>
    <input type="text" readonly class="form-control-static" id="staticEmail2" value="email@example.com">
Mark Otto's avatar
Mark Otto committed
670
  </div>
671
  <div class="form-group mx-sm-3">
Mark Otto's avatar
Mark Otto committed
672
673
674
    <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
675
  <button type="submit" class="btn btn-primary">Confirm identity</button>
Mark Otto's avatar
Mark Otto committed
676
677
678
</form>
{% endexample %}

Mark Otto's avatar
Mark Otto committed
679
## Disabled states
Mark Otto's avatar
Mark Otto committed
680

681
Add the `disabled` boolean attribute on an input to prevent user interactions and make it appear lighter.
Mark Otto's avatar
Mark Otto committed
682
683

{% highlight html %}
Mark Otto's avatar
Mark Otto committed
684
685
686
687
688
689
<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
690
<form>
Mark Otto's avatar
Mark Otto committed
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
  <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
710
{% endexample %}
Mark Otto's avatar
Mark Otto committed
711

712
{% callout warning %}
Mark Otto's avatar
Mark Otto committed
713
#### Caveat with anchors
Mark Otto's avatar
Mark Otto committed
714

Mark Otto's avatar
Mark Otto committed
715
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 }}/docs/{{ site.docs_version }}/components/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.
716
717
718
719
720
721
722
{% 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
723
724
725

## Readonly inputs

726
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
727
728

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

Mark Otto's avatar
Mark Otto committed
732
733
734
735
736
## Control sizing

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

{% example html %}
737
<input class="form-control form-control-lg" type="text" placeholder=".form-control-lg">
Mark Otto's avatar
Mark Otto committed
738
<input class="form-control" type="text" placeholder="Default input">
739
<input class="form-control form-control-sm" type="text" placeholder=".form-control-sm">
Mark Otto's avatar
Mark Otto committed
740
741
742
{% endexample %}

{% example html %}
743
744
745
746
747
748
749
750
751
<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
752
753
754
755
756
757
758
759
{% endexample %}

## Column sizing

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

{% example html %}
<div class="row">
760
761
  <div class="col-2">
    <input type="text" class="form-control" placeholder=".col-2">
Mark Otto's avatar
Mark Otto committed
762
  </div>
763
764
  <div class="col-3">
    <input type="text" class="form-control" placeholder=".col-3">
Mark Otto's avatar
Mark Otto committed
765
  </div>
766
767
  <div class="col-4">
    <input type="text" class="form-control" placeholder=".col-4">
Mark Otto's avatar
Mark Otto committed
768
769
770
771
772
773
  </div>
</div>
{% endexample %}

## Help text

774
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
775

776
777
778
779
780
781
{% 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 %}

782
783
784
785
786
787
788
789
790
791
792
793
794
795
### 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
796
Inline text can use any typical inline HTML element (be it a `<small>`, `<span>`, or something else).
Mark Otto's avatar
Mark Otto committed
797
798

{% example html %}
799
800
<form class="form-inline">
  <div class="form-group">
Bardi Harborow's avatar
Bardi Harborow committed
801
802
    <label for="inputPassword6">Password</label>
    <input type="password" id="inputPassword6" class="form-control mx-sm-3" aria-describedby="passwordHelpInline">
803
804
805
806
807
    <small id="passwordHelpInline" class="text-muted">
      Must be 8-20 characters long.
    </small>
  </div>
</form>
808
809
{% endexample %}

Mark Otto's avatar
Mark Otto committed
810
## Validation
Mark Otto's avatar
Mark Otto committed
811

Mark Otto's avatar
Mark Otto committed
812
813
Provide valuable, actionable feedback to your users with HTML5 form validation–[available in all our supported browsers](http://caniuse.com/#feat=form-validation). Choose from the browser default validation feedback, or implement custom messages with our built-in classes and starter JavaScript.

Mark Otto's avatar
Mark Otto committed
814
815
816
{% callout warning %}
We **highly recommend** custom validation styles as native browser defaults are not announced to screenreaders.
{% endcallout %}
Mark Otto's avatar
Mark Otto committed
817
818
819

### How it works

Mark Otto's avatar
Mark Otto committed
820
821
Here's a rundown of how form validation works:

822
823
824
- HTML form validation includes support for two CSS pseudo-classes, `:invalid` and `:valid`, on `<input>`, `<select>`, and `<textarea>` elements.
- Due to constaints in how CSS works, we cannot (at present) apply styles to a `<label>` that comes before a form control in the DOM without the help of custom JavaScript.
- Bootstrap scopes the `:invalid` and `:valid` styles to parent `.was-validated` class, usually applied to the `<form>`. Otherwise, any required field without a value shows up as invalid on page load. This way, you may choose when to activate them (typically after form submission is attempted).
Mark Otto's avatar
Mark Otto committed
825
- All modern browsers support the [constraint validation API](https://www.w3.org/TR/html5/forms.html#the-constraint-validation-api), a series of JavaScript methods for validating form controls.
826
- Feedback messages may utilize the browser defaults (different for each browser, and unstylable via CSS) or our custom feedback styles with additional HTML and CSS.
Mark Otto's avatar
Mark Otto committed
827
828
- You may provide custom validity messages with `setCustomValidity` in JavaScript.

829
830
831
832
With that in mind, consider the following two demos for our custom form validation styles and browser defaults.

### Custom styles

Mark Otto's avatar
Mark Otto committed
833
For custom Bootstrap form validation messages, you'll need to add the `novalidate` boolean attribute to your `<form>`. This disables the browser default feedback tooltips, but still provides access to the form validation APIs in JavaScript. Try to submit the form below; our JavaScript will intercept the submit button and relay feedback to you.
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873

{% example html %}
<form class="container" id="needs-validation" novalidate>
  <div class="row">
    <div class="col-md-6 mb-3">
      <label for="validationCustom01">First name</label>
      <input type="text" class="form-control" id="validationCustom01" placeholder="First name" value="Mark" required>
    </div>
    <div class="col-md-6 mb-3">
      <label for="validationCustom02">Last name</label>
      <input type="text" class="form-control" id="validationCustom02" placeholder="Last name" value="Otto" required>
    </div>
  </div>
  <div class="row">
    <div class="col-md-6 mb-3">
      <label for="validationCustom03">City</label>
      <input type="text" class="form-control" id="validationCustom03" placeholder="City" required>
      <div class="invalid-feedback">
        Please provide a valid city.
      </div>
    </div>
    <div class="col-md-3 mb-3">
      <label for="validationCustom04">State</label>
      <input type="text" class="form-control" id="validationCustom04" placeholder="State" required>
      <div class="invalid-feedback">
        Please provide a valid state.
      </div>
    </div>
    <div class="col-md-3 mb-3">
      <label for="validationCustom05">Zip</label>
      <input type="text" class="form-control" id="validationCustom05" placeholder="Zip" required>
      <div class="invalid-feedback">
        Please provide a valid zip.
      </div>
    </div>
  </div>
  <button class="btn btn-primary" type="submit">Submit form</button>
</form>

<script>
Mark Otto's avatar
Mark Otto committed
874
// Example starter JavaScript for disabling form submissions if there are invalid fields
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
(function() {
  "use strict";
  window.addEventListener("load", function() {
    var form = document.getElementById("needs-validation");
    form.addEventListener("submit", function(event) {
      if (form.checkValidity() == false) {
        event.preventDefault();
        event.stopPropagation();
      }
      form.classList.add("was-validated");
    }, false);
  }, false);
}());
</script>
{% endexample %}

### Browser defaults

893
894
895
896
Not interested in custom validation feedback messages or writing JavaScript to change form behaviors? All good, you can use the browser defaults. Try submitting the form below. Depending on your browser and OS, you'll see a slightly different style of feedback.

While these feedback styles cannot be styled with CSS, you can still customize the feedback text through JavaScript.

897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
{% example html %}
<form>
  <div class="row">
    <div class="col-md-6 mb-3">
      <input type="text" class="form-control" placeholder="First name" value="Mark" required>
    </div>
    <div class="col-md-6 mb-3">
      <input type="text" class="form-control" placeholder="Last name" value="Otto" required>
    </div>
  </div>

  <div class="row">
    <div class="col-md-7 mb-3">
      <input type="text" class="form-control" placeholder="City" required>
    </div>
    <div class="col-md-3 mb-3">
      <input type="text" class="form-control" placeholder="State" required>
    </div>
    <div class="col-md-2 mb-3">
      <input type="text" class="form-control" placeholder="Zip" required>
    </div>
  </div>

  <button class="btn btn-primary" type="submit">Submit form</button>
</form>
{% endexample %}

### Supported elements

Our example forms show native textual `<input>`s above, but form validation styles are available for our custom form controls, too.

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

  <div class="custom-controls-stacked d-block my-3">
    <label class="custom-control custom-radio">
      <input id="radioStacked1" name="radio-stacked" type="radio" class="custom-control-input" required>
      <span class="custom-control-indicator"></span>
      <span class="custom-control-description">Toggle this custom radio</span>
    </label>
    <label class="custom-control custom-radio">
      <input id="radioStacked2" name="radio-stacked" type="radio" class="custom-control-input" required>
      <span class="custom-control-indicator"></span>
      <span class="custom-control-description">Or toggle this other custom radio</span>
    </label>
  </div>

  <select class="custom-select d-block my-3" required>
    <option value="">Open this select menu</option>
    <option value="1">One</option>
    <option value="2">Two</option>
    <option value="3">Three</option>
  </select>

  <label class="custom-file">
    <input type="file" id="file" class="custom-file-input" required>
    <span class="custom-file-control"></span>
  </label>
</form>
{% endexample %}
962

963
- 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.
964
- 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.
965
966
- 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.
967
- 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
968

Mark Otto's avatar
Mark Otto committed
969
970
### Defining states

Mark Otto's avatar
Mark Otto committed
971
972
973
974
975
976
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.

977
{% comment %}
978
979
980
981
982
{% 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.

Mark Otto's avatar
Mark Otto committed
983
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 }}/docs/{{ site.docs_version }}/components/#glyphicons) (with appropriate alternative text using the `.sr-only` class - see the [Glyphicon examples]({{ site.baseurl }}/docs/{{ site.docs_version }}/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.
984
{% endcallout %}
985
{% endcomment %}
Mark Otto's avatar
Mark Otto committed
986

Mark Otto's avatar
Mark Otto committed
987
988
989
990
### Examples

Here are some examples of the aforementioned classes in action. First up is your standard left-aligned fields with labels, help text, and validation messaging.

Mark Otto's avatar
Mark Otto committed
991
{% example html %}
Mark Otto's avatar
Mark Otto committed
992
<div class="form-group has-success">
993
  <label class="form-control-label" for="inputSuccess1">Input with success</label>
994
  <input type="text" class="form-control form-control-success" id="inputSuccess1">
Mark Otto's avatar
Mark Otto committed
995
  <div class="form-control-feedback">Success! You've done it.</div>
996
  <small class="form-text text-muted">Example help text that remains unchanged.</small>
Mark Otto's avatar
Mark Otto committed
997
998
</div>
<div class="form-group has-warning">
999
  <label class="form-control-label" for="inputWarning1">Input with warning</label>
1000
  <input type="text" class="form-control form-control-warning" id="inputWarning1">
For faster browsing, not all history is shown. View entire blame