forms.md 44.8 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
Quy's avatar
Quy committed
4
description: Examples and usage guidelines for form 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
Be sure to use an appropriate `type` attribute on all inputs (e.g., `email` for email address or `number` for numerical information).
20

21
22
### Example

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

94
95
### Supported controls

96
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.
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
122
123
124
125

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

172
173
### Textual inputs

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

176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
| 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"> |
191

192
193
194
195
196
197
## 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

198
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
199

200
201
{% example html %}
<form>
202
  <div class="form-group">
Mark Otto's avatar
Mark Otto committed
203
    <label class="form-control-label" for="formGroupExampleInput">Example label</label>
204
    <input type="text" class="form-control" id="formGroupExampleInput" placeholder="Example input">
205
206
  </div>
  <div class="form-group">
Mark Otto's avatar
Mark Otto committed
207
    <label class="form-control-label" for="formGroupExampleInput2">Another label</label>
208
    <input type="text" class="form-control" id="formGroupExampleInput2" placeholder="Another input">
209
  </div>
210
211
212
</form>
{% endexample %}

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
322
323
324
325
326
327
### 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 %}

328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
{% 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 %}

354
355
### Inline forms

356
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.
357

358
- Controls are `display: flex`, collapsing any HTML white space and allowing you to provide alignment control with [spacing]({{ site.baseurl }}/utilities/spacing/) and [flexbox]({{ site.baseurl }}/utilities/flexbox/) utilities.
359
360
- 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
361

362
You may need to manually address the width and alignment of individual form controls with [spacing utilities]({{ site.baseurl }}/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
363
364

{% example html %}
365
<form class="form-inline">
366
367
  <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
368

369
370
371
372
  <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
373
  </div>
374
375

  <div class="form-check mb-2 mr-sm-2 mb-sm-0">
376
377
    <label class="form-check-label">
      <input class="form-check-input" type="checkbox"> Remember me
Mark Otto's avatar
Mark Otto committed
378
379
    </label>
  </div>
380
381

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

385
386
Custom form controls and selects are also supported.

Mark Otto's avatar
Mark Otto committed
387
388
{% example html %}
<form class="form-inline">
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
  <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
404
</form>
Mark Otto's avatar
Mark Otto committed
405
{% endexample %}
Mark Otto's avatar
Mark Otto committed
406

407
{% callout warning %}
Mark Otto's avatar
Mark Otto committed
408
409
410
#### 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 %}
411

412
### Using the Grid
Mark Otto's avatar
Mark Otto committed
413

Bardi Harborow's avatar
Bardi Harborow committed
414
For more structured form layouts that are also responsive, you can utilize Bootstrap's [predefined grid classes]({{ site.baseurl }}/layout/grid/) 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
415

416
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
417
418

{% example html %}
419
420
421
<div class="container">
  <form>
    <div class="form-group row">
422
      <label for="inputEmail3" class="col-sm-2 col-form-label">Email</label>
423
424
425
      <div class="col-sm-10">
        <input type="email" class="form-control" id="inputEmail3" placeholder="Email">
      </div>
Mark Otto's avatar
Mark Otto committed
426
    </div>
427
    <div class="form-group row">
428
      <label for="inputPassword3" class="col-sm-2 col-form-label">Password</label>
429
430
431
      <div class="col-sm-10">
        <input type="password" class="form-control" id="inputPassword3" placeholder="Password">
      </div>
Mark Otto's avatar
Mark Otto committed
432
    </div>
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
    <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>
455
        </div>
456
      </div>
457
    </fieldset>
458
    <div class="form-group row">
459
      <div class="col-sm-2">Checkbox</div>
460
      <div class="col-sm-10">
461
462
463
        <div class="form-check">
          <label class="form-check-label">
            <input class="form-check-input" type="checkbox"> Check me out
464
465
          </label>
        </div>
466
      </div>
467
468
    </div>
    <div class="form-group row">
469
470
      <div class="offset-sm-2 col-sm-10">
        <button type="submit" class="btn btn-primary">Sign in</button>
471
472
      </div>
    </div>
473
474
475
476
  </form>
</div>
{% endexample %}

Mark Otto's avatar
Mark Otto committed
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
520
521
522
523
524
525
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 %}

526
527
528
529
530
531
Grid-based form layouts also support large and small inputs.

{% example html %}
<div class="container">
  <form>
    <div class="form-group row">
532
      <label for="lgFormGroupInput" class="col-sm-2 col-form-label col-form-label-lg">Email</label>
533
534
      <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
535
      </div>
536
    </div>
537
    <div class="form-group row">
538
      <label for="smFormGroupInput" class="col-sm-2 col-form-label col-form-label-sm">Email</label>
539
540
541
      <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
542
    </div>
543
544
  </form>
</div>
Mark Otto's avatar
Mark Otto committed
545
{% endexample %}
Mark Otto's avatar
Mark Otto committed
546

547
## Checkboxes and radios
Mark Otto's avatar
Mark Otto committed
548

Mark Otto's avatar
Mark Otto committed
549
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
550

551
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
552

553
### Default (stacked)
Mark Otto's avatar
Mark Otto committed
554

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

572
{% example html %}
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="exampleRadios1" value="option1" checked>
Mark Otto's avatar
Mark Otto committed
576
577
578
    Option one is this and that&mdash;be sure to include why it's great
  </label>
</div>
Mark Otto's avatar
Mark Otto committed
579
580
581
<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
582
583
584
    Option two can be something else and selecting it will deselect option one
  </label>
</div>
Mark Otto's avatar
Mark Otto committed
585
586
587
<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
588
589
590
    Option three is disabled
  </label>
</div>
Mark Otto's avatar
Mark Otto committed
591
{% endexample %}
Mark Otto's avatar
Mark Otto committed
592

593
### Inline
Mark Otto's avatar
Mark Otto committed
594

595
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
596
597

{% example html %}
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
<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>
613
{% endexample %}
Mark Otto's avatar
Mark Otto committed
614

615
{% example html %}
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
<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
631
{% endexample %}
Mark Otto's avatar
Mark Otto committed
632

633
### Without labels
Mark Otto's avatar
Mark Otto committed
634

635
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
636
637

{% example html %}
Mark Otto's avatar
Mark Otto committed
638
639
640
<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
641
642
  </label>
</div>
Mark Otto's avatar
Mark Otto committed
643
644
645
<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
646
647
648
649
  </label>
</div>
{% endexample %}

Mark Otto's avatar
Mark Otto committed
650
## Static controls
Mark Otto's avatar
Mark Otto committed
651

652
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
653
654

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

Mark Otto's avatar
Mark Otto committed
671
{% example html %}
Mark Otto's avatar
Mark Otto committed
672
<form class="form-inline">
Mark Otto's avatar
Mark Otto committed
673
  <div class="form-group">
674
675
    <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
676
  </div>
677
  <div class="form-group mx-sm-3">
Mark Otto's avatar
Mark Otto committed
678
679
680
    <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
681
  <button type="submit" class="btn btn-primary">Confirm identity</button>
Mark Otto's avatar
Mark Otto committed
682
683
684
</form>
{% endexample %}

Mark Otto's avatar
Mark Otto committed
685
## Disabled states
Mark Otto's avatar
Mark Otto committed
686

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

{% highlight html %}
Mark Otto's avatar
Mark Otto committed
690
691
692
693
694
695
<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
696
<form>
Mark Otto's avatar
Mark Otto committed
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
  <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
716
{% endexample %}
Mark Otto's avatar
Mark Otto committed
717

718
719
{% callout warning %}
#### Caveat about link functionality of `<a>`
Mark Otto's avatar
Mark Otto committed
720

721
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 }}/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.
722
723
724
725
726
727
728
{% 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
729
730
731

## Readonly inputs

732
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
733
734

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

Mark Otto's avatar
Mark Otto committed
738
739
740
741
742
## Control sizing

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

{% example html %}
743
<input class="form-control form-control-lg" type="text" placeholder=".form-control-lg">
Mark Otto's avatar
Mark Otto committed
744
<input class="form-control" type="text" placeholder="Default input">
745
<input class="form-control form-control-sm" type="text" placeholder=".form-control-sm">
Mark Otto's avatar
Mark Otto committed
746
747
748
{% endexample %}

{% example html %}
749
750
751
752
753
754
755
756
757
<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
758
759
760
761
762
763
764
765
{% endexample %}

## Column sizing

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

{% example html %}
<div class="row">
766
767
  <div class="col-2">
    <input type="text" class="form-control" placeholder=".col-2">
Mark Otto's avatar
Mark Otto committed
768
  </div>
769
770
  <div class="col-3">
    <input type="text" class="form-control" placeholder=".col-3">
Mark Otto's avatar
Mark Otto committed
771
  </div>
772
773
  <div class="col-4">
    <input type="text" class="form-control" placeholder=".col-4">
Mark Otto's avatar
Mark Otto committed
774
775
776
777
778
779
  </div>
</div>
{% endexample %}

## Help text

780
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
781

782
783
784
785
786
787
{% 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 %}

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

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

Mark Otto's avatar
Mark Otto committed
816
## Validation
Mark Otto's avatar
Mark Otto committed
817

Mark Otto's avatar
Mark Otto committed
818
819
820
821
822
Bootstrap includes validation styles for danger, warning, and success states on most form controls.

### How it works

Here's a rundown of how they work:
823

824
- 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.
825
- 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.
826
827
- 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.
828
- 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
829

Mark Otto's avatar
Mark Otto committed
830
831
### Defining states

Mark Otto's avatar
Mark Otto committed
832
833
834
835
836
837
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.

838
{% comment %}
839
840
841
842
843
{% 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.

844
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.
845
{% endcallout %}
846
{% endcomment %}
Mark Otto's avatar
Mark Otto committed
847

Mark Otto's avatar
Mark Otto committed
848
849
850
851
### 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
852
{% example html %}
Mark Otto's avatar
Mark Otto committed
853
<div class="form-group has-success">
854
  <label class="form-control-label" for="inputSuccess1">Input with success</label>
855
  <input type="text" class="form-control form-control-success" id="inputSuccess1">
Mark Otto's avatar
Mark Otto committed
856
  <div class="form-control-feedback">Success! You've done it.</div>
857
  <small class="form-text text-muted">Example help text that remains unchanged.</small>
Mark Otto's avatar
Mark Otto committed
858
859
</div>
<div class="form-group has-warning">
860
  <label class="form-control-label" for="inputWarning1">Input with warning</label>
861
  <input type="text" class="form-control form-control-warning" id="inputWarning1">
Mark Otto's avatar
Mark Otto committed
862
  <div class="form-control-feedback">Shucks, check the formatting of that and try again.</div>
863
  <small class="form-text text-muted">Example help text that remains unchanged.</small>
Mark Otto's avatar
Mark Otto committed
864
</div>
865
<div class="form-group has-danger">
866
  <label class="form-control-label" for="inputDanger1">Input with danger</label>
Mark Otto's avatar
Mark Otto committed
867
  <input type="text" class="form-control form-control-danger" id="inputDanger1">
868
  <div class="form-control-feedback">Sorry, that username's taken. Try another?</div>
869
  <small class="form-text text-muted">Example help text that remains unchanged.</small>
Mark Otto's avatar
Mark Otto committed
870
</div>
Mark Otto's avatar
Mark Otto committed
871
{% endexample %}
872

Mark Otto's avatar
Mark Otto committed
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
Those same states can also be used with horizontal forms.

{% example html %}
<div class="container">
  <form>
    <div class="form-group row has-success">
      <label for="inputHorizontalSuccess" class="col-sm-2 col-form-label">Email</label>
      <div class="col-sm-10">
        <input type="email" class="form-control form-control-success" id="inputHorizontalSuccess" placeholder="name@example.com">
        <div class="form-control-feedback">Success! You've done it.</div>
        <small class="form-text text-muted">Example help text that remains unchanged.</small>
      </div>
    </div>
    <div class="form-group row has-warning">
      <label for="inputHorizontalWarning" class="col-sm-2 col-form-label">Email</label>
      <div class="col-sm-10">
        <input type="email" class="form-control form-control-warning" id="inputHorizontalWarning" placeholder="name@example.com">
        <div class="form-control-feedback">Shucks, check the formatting of that and try again.</div>
        <small class="form-text text-muted">Example help text that remains unchanged.</small>
      </div>
    </div>
    <div class="form-group row has-danger">
      <label for="inputHorizontalDnger" class="col-sm-2 col-form-label">Email</label>
      <div class="col-sm-10">
        <input type="email" class="form-control form-control-danger" id="inputHorizontalDnger" placeholder="name@example.com">
        <div class="form-control-feedback">Sorry, that username's taken. Try another?</div>
        <small class="form-text text-muted">Example help text that remains unchanged.</small>
      </div>
    </div>
  </form>
</div>
{% endexample %}

Checkboxes and radios are also supported.

Mark Otto's avatar
Mark Otto committed
908
{% example html %}
909
910
911
<div class="form-check has-success">
  <label class="form-check-label">
    <input type="checkbox" class="form-check-input" id="checkboxSuccess" value="option1">
912
913
    Checkbox with success
  </label>
914
</div>
915
916
917
<div class="form-check has-warning">
  <label class="form-check-label">
    <input type="checkbox" class="form-check-input" id="checkboxWarning" value="option1">
918
919
    Checkbox with warning
  </label>
Mark Otto's avatar
Mark Otto committed
920
</div>
921
922
923
<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
924
    Checkbox with danger
925
  </label>
926
</div>
Mark Otto's avatar
Mark Otto committed
927
{% endexample %}
Mark Otto's avatar
Mark Otto committed
928

929
930
## Custom forms

931
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.
932
933
934
935
936
937
938
939
940

### 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
941
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.
942

Mark Otto's avatar
Mark Otto committed
943
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.
944

XhmikosR's avatar
XhmikosR committed
945
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.
946
947
948
949

#### Checkboxes

{% example html %}
Mark Otto's avatar
Mark Otto committed
950
951
952
953
<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>
954
955
956
</label>
{% endexample %}

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

<div class="bd-example bd-example-indeterminate">
Mark Otto's avatar
Mark Otto committed
960
961
962
963
  <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>
964
965
966
  </label>
</div>

Mark Otto's avatar
Mark Otto committed
967
If you're using jQuery, something like this should suffice:
968
969
970
971
972
973
974
975

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

#### Radios

{% example html %}
Mark Otto's avatar
Mark Otto committed
976
977
978
979
<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>
980
</label>
Mark Otto's avatar
Mark Otto committed
981
982
983
984
<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>
985
986
987
</label>
{% endexample %}

Mark Otto's avatar
Mark Otto committed
988
989
#### Disabled

Mark Otto's avatar
Mark Otto committed
990
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
991
992
993
994
995
996
997
998
999
1000

{% 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>
For faster browsing, not all history is shown. View entire blame