forms.md 41.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
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

11
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
12

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

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

86
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.
87
88
89
90
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

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

162
163
164
165
166
167
### Textual inputs

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

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

247
248
249
250
251
252
## 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

253
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
254

255
256
{% example html %}
<form>
257
  <div class="form-group">
Mark Otto's avatar
Mark Otto committed
258
    <label class="form-control-label" for="formGroupExampleInput">Example label</label>
259
    <input type="text" class="form-control" id="formGroupExampleInput" placeholder="Example input">
260
261
  </div>
  <div class="form-group">
Mark Otto's avatar
Mark Otto committed
262
    <label class="form-control-label" for="formGroupExampleInput2">Another label</label>
263
    <input type="text" class="form-control" id="formGroupExampleInput2" placeholder="Another input">
264
  </div>
265
266
267
268
269
</form>
{% endexample %}

### Inline forms

270
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.
271

272
- 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.
273
274
- 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
275

276
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
277
278

{% example html %}
279
<form class="form-inline">
280
281
  <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
282

283
284
285
286
  <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
287
  </div>
288
289

  <div class="form-check mb-2 mr-sm-2 mb-sm-0">
290
291
    <label class="form-check-label">
      <input class="form-check-input" type="checkbox"> Remember me
Mark Otto's avatar
Mark Otto committed
292
293
    </label>
  </div>
294
295

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

299
300
Custom form controls and selects are also supported.

Mark Otto's avatar
Mark Otto committed
301
302
{% example html %}
<form class="form-inline">
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
  <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
318
</form>
Mark Otto's avatar
Mark Otto committed
319
{% endexample %}
Mark Otto's avatar
Mark Otto committed
320

321
{% callout warning %}
Mark Otto's avatar
Mark Otto committed
322
323
324
#### 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 %}
325

326
### Using the Grid
Mark Otto's avatar
Mark Otto committed
327

Bardi Harborow's avatar
Bardi Harborow committed
328
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
329

330
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
331
332

{% example html %}
333
334
335
<div class="container">
  <form>
    <div class="form-group row">
336
      <label for="inputEmail3" class="col-sm-2 col-form-label">Email</label>
337
338
339
      <div class="col-sm-10">
        <input type="email" class="form-control" id="inputEmail3" placeholder="Email">
      </div>
Mark Otto's avatar
Mark Otto committed
340
    </div>
341
    <div class="form-group row">
342
      <label for="inputPassword3" class="col-sm-2 col-form-label">Password</label>
343
344
345
      <div class="col-sm-10">
        <input type="password" class="form-control" id="inputPassword3" placeholder="Password">
      </div>
Mark Otto's avatar
Mark Otto committed
346
    </div>
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
    <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>
369
        </div>
370
      </div>
371
    </fieldset>
372
    <div class="form-group row">
373
      <div class="col-sm-2">Checkbox</div>
374
      <div class="col-sm-10">
375
376
377
        <div class="form-check">
          <label class="form-check-label">
            <input class="form-check-input" type="checkbox"> Check me out
378
379
          </label>
        </div>
380
      </div>
381
382
    </div>
    <div class="form-group row">
383
384
      <div class="offset-sm-2 col-sm-10">
        <button type="submit" class="btn btn-primary">Sign in</button>
385
386
      </div>
    </div>
387
388
389
390
  </form>
</div>
{% endexample %}

Mark Otto's avatar
Mark Otto committed
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
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 %}

440
441
442
443
444
445
Grid-based form layouts also support large and small inputs.

{% example html %}
<div class="container">
  <form>
    <div class="form-group row">
446
      <label for="lgFormGroupInput" class="col-sm-2 col-form-label col-form-label-lg">Email</label>
447
448
      <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
449
      </div>
450
    </div>
451
    <div class="form-group row">
452
      <label for="smFormGroupInput" class="col-sm-2 col-form-label col-form-label-sm">Email</label>
453
454
455
      <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
456
    </div>
457
458
  </form>
</div>
Mark Otto's avatar
Mark Otto committed
459
{% endexample %}
Mark Otto's avatar
Mark Otto committed
460

461
## Checkboxes and radios
Mark Otto's avatar
Mark Otto committed
462

Mark Otto's avatar
Mark Otto committed
463
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
464

465
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
466

467
### Default (stacked)
Mark Otto's avatar
Mark Otto committed
468

469
470
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
471
{% example html %}
Mark Otto's avatar
Mark Otto committed
472
473
474
<div class="form-check">
  <label class="form-check-label">
    <input class="form-check-input" type="checkbox" value="">
Mark Otto's avatar
Mark Otto committed
475
476
477
    Option one is this and that&mdash;be sure to include why it's great
  </label>
</div>
Mark Otto's avatar
Mark Otto committed
478
479
480
<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
481
482
483
    Option two is disabled
  </label>
</div>
484
{% endexample %}
Mark Otto's avatar
Mark Otto committed
485

486
{% example html %}
Mark Otto's avatar
Mark Otto committed
487
488
489
<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
490
491
492
    Option one is this and that&mdash;be sure to include why it's great
  </label>
</div>
Mark Otto's avatar
Mark Otto committed
493
494
495
<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
496
497
498
    Option two can be something else and selecting it will deselect option one
  </label>
</div>
Mark Otto's avatar
Mark Otto committed
499
500
501
<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
502
503
504
    Option three is disabled
  </label>
</div>
Mark Otto's avatar
Mark Otto committed
505
{% endexample %}
Mark Otto's avatar
Mark Otto committed
506

507
### Inline
Mark Otto's avatar
Mark Otto committed
508

509
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
510
511

{% example html %}
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
<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>
527
{% endexample %}
Mark Otto's avatar
Mark Otto committed
528

529
{% example html %}
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
<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
545
{% endexample %}
Mark Otto's avatar
Mark Otto committed
546

547
### Without labels
Mark Otto's avatar
Mark Otto committed
548

549
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
550
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" id="blankCheckbox" value="option1" aria-label="...">
Mark Otto's avatar
Mark Otto committed
555
556
  </label>
</div>
Mark Otto's avatar
Mark Otto committed
557
558
559
<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
560
561
562
563
  </label>
</div>
{% endexample %}

Mark Otto's avatar
Mark Otto committed
564
## Static controls
Mark Otto's avatar
Mark Otto committed
565

566
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
567
568

{% example html %}
569
<form>
570
  <div class="form-group row">
571
    <label for="staticEmail" class="col-sm-2 col-form-label">Email</label>
Mark Otto's avatar
Mark Otto committed
572
    <div class="col-sm-10">
573
      <input type="text" readonly class="form-control-static" id="staticEmail" value="email@example.com">
Mark Otto's avatar
Mark Otto committed
574
575
    </div>
  </div>
576
  <div class="form-group row">
577
    <label for="inputPassword" class="col-sm-2 col-form-label">Password</label>
Mark Otto's avatar
Mark Otto committed
578
579
580
581
582
    <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
583
{% endexample %}
Mark Otto's avatar
Mark Otto committed
584

Mark Otto's avatar
Mark Otto committed
585
{% example html %}
Mark Otto's avatar
Mark Otto committed
586
<form class="form-inline">
Mark Otto's avatar
Mark Otto committed
587
  <div class="form-group">
588
589
    <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
590
  </div>
591
  <div class="form-group mx-sm-3">
Mark Otto's avatar
Mark Otto committed
592
593
594
    <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
595
  <button type="submit" class="btn btn-primary">Confirm identity</button>
Mark Otto's avatar
Mark Otto committed
596
597
598
</form>
{% endexample %}

Mark Otto's avatar
Mark Otto committed
599
## Disabled states
Mark Otto's avatar
Mark Otto committed
600

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

{% highlight html %}
Mark Otto's avatar
Mark Otto committed
604
605
606
607
608
609
<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
610
<form>
Mark Otto's avatar
Mark Otto committed
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
  <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
630
{% endexample %}
Mark Otto's avatar
Mark Otto committed
631

632
{% callout warning %}
Mark Otto's avatar
Mark Otto committed
633
#### Caveat with anchors
Mark Otto's avatar
Mark Otto committed
634

635
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.
636
637
638
639
640
641
642
{% 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
643
644
645

## Readonly inputs

646
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
647
648

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

Mark Otto's avatar
Mark Otto committed
652
653
654
655
656
## Control sizing

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

{% example html %}
657
<input class="form-control form-control-lg" type="text" placeholder=".form-control-lg">
Mark Otto's avatar
Mark Otto committed
658
<input class="form-control" type="text" placeholder="Default input">
659
<input class="form-control form-control-sm" type="text" placeholder=".form-control-sm">
Mark Otto's avatar
Mark Otto committed
660
661
662
{% endexample %}

{% example html %}
663
664
665
666
667
668
669
670
671
<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
672
673
674
675
676
677
678
679
{% endexample %}

## Column sizing

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

{% example html %}
<div class="row">
680
681
  <div class="col-2">
    <input type="text" class="form-control" placeholder=".col-2">
Mark Otto's avatar
Mark Otto committed
682
  </div>
683
684
  <div class="col-3">
    <input type="text" class="form-control" placeholder=".col-3">
Mark Otto's avatar
Mark Otto committed
685
  </div>
686
687
  <div class="col-4">
    <input type="text" class="form-control" placeholder=".col-4">
Mark Otto's avatar
Mark Otto committed
688
689
690
691
692
693
  </div>
</div>
{% endexample %}

## Help text

694
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
695

696
697
698
699
700
701
{% 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 %}

702
703
704
705
706
707
708
709
710
711
712
713
714
715
### 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
716
Inline text can use any typical inline HTML element (be it a `<small>`, `<span>`, or something else).
Mark Otto's avatar
Mark Otto committed
717
718

{% example html %}
719
720
<form class="form-inline">
  <div class="form-group">
Bardi Harborow's avatar
Bardi Harborow committed
721
722
    <label for="inputPassword6">Password</label>
    <input type="password" id="inputPassword6" class="form-control mx-sm-3" aria-describedby="passwordHelpInline">
723
724
725
726
727
    <small id="passwordHelpInline" class="text-muted">
      Must be 8-20 characters long.
    </small>
  </div>
</form>
728
729
{% endexample %}

Mark Otto's avatar
Mark Otto committed
730
## Validation
Mark Otto's avatar
Mark Otto committed
731

Mark Otto's avatar
Mark Otto committed
732
733
734
735
736
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:
737

738
- 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.
739
- 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.
740
741
- 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.
742
- 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
743

Mark Otto's avatar
Mark Otto committed
744
745
### Defining states

Mark Otto's avatar
Mark Otto committed
746
747
748
749
750
751
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.

752
{% comment %}
753
754
755
756
757
{% 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.

758
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.
759
{% endcallout %}
760
{% endcomment %}
Mark Otto's avatar
Mark Otto committed
761

Mark Otto's avatar
Mark Otto committed
762
763
764
765
### 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
766
{% example html %}
Mark Otto's avatar
Mark Otto committed
767
<div class="form-group has-success">
768
  <label class="form-control-label" for="inputSuccess1">Input with success</label>
769
  <input type="text" class="form-control form-control-success" id="inputSuccess1">
Mark Otto's avatar
Mark Otto committed
770
  <div class="form-control-feedback">Success! You've done it.</div>
771
  <small class="form-text text-muted">Example help text that remains unchanged.</small>
Mark Otto's avatar
Mark Otto committed
772
773
</div>
<div class="form-group has-warning">
774
  <label class="form-control-label" for="inputWarning1">Input with warning</label>
775
  <input type="text" class="form-control form-control-warning" id="inputWarning1">
Mark Otto's avatar
Mark Otto committed
776
  <div class="form-control-feedback">Shucks, check the formatting of that and try again.</div>
777
  <small class="form-text text-muted">Example help text that remains unchanged.</small>
Mark Otto's avatar
Mark Otto committed
778
</div>
779
<div class="form-group has-danger">
780
  <label class="form-control-label" for="inputDanger1">Input with danger</label>
Mark Otto's avatar
Mark Otto committed
781
  <input type="text" class="form-control form-control-danger" id="inputDanger1">
782
  <div class="form-control-feedback">Sorry, that username's taken. Try another?</div>
783
  <small class="form-text text-muted">Example help text that remains unchanged.</small>
Mark Otto's avatar
Mark Otto committed
784
</div>
Mark Otto's avatar
Mark Otto committed
785
{% endexample %}
786

Mark Otto's avatar
Mark Otto committed
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
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
822
{% example html %}
823
824
825
<div class="form-check has-success">
  <label class="form-check-label">
    <input type="checkbox" class="form-check-input" id="checkboxSuccess" value="option1">
826
827
    Checkbox with success
  </label>
828
</div>
829
830
831
<div class="form-check has-warning">
  <label class="form-check-label">
    <input type="checkbox" class="form-check-input" id="checkboxWarning" value="option1">
832
833
    Checkbox with warning
  </label>
Mark Otto's avatar
Mark Otto committed
834
</div>
835
836
837
<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
838
    Checkbox with danger
839
  </label>
840
</div>
Mark Otto's avatar
Mark Otto committed
841
{% endexample %}
Mark Otto's avatar
Mark Otto committed
842

843
844
## Custom forms

845
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.
846
847
848
849
850
851
852
853
854

### 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
855
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.
856

Mark Otto's avatar
Mark Otto committed
857
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.
858

XhmikosR's avatar
XhmikosR committed
859
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.
860
861
862
863

#### Checkboxes

{% example html %}
Mark Otto's avatar
Mark Otto committed
864
865
866
867
<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>
868
869
870
</label>
{% endexample %}

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

<div class="bd-example bd-example-indeterminate">
Mark Otto's avatar
Mark Otto committed
874
875
876
877
  <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>
878
879
880
  </label>
</div>

Mark Otto's avatar
Mark Otto committed
881
If you're using jQuery, something like this should suffice:
882
883
884
885
886
887
888
889

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

#### Radios

{% example html %}
Mark Otto's avatar
Mark Otto committed
890
891
892
893
<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>
894
</label>
Mark Otto's avatar
Mark Otto committed
895
896
897
898
<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>
899
900
901
</label>
{% endexample %}

Mark Otto's avatar
Mark Otto committed
902
903
#### Disabled

Mark Otto's avatar
Mark Otto committed
904
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
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919

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

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

920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
#### Validation states

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

{% example html %}
<div class="form-group has-success">
  <label class="custom-control custom-checkbox">
    <input type="checkbox" class="custom-control-input">
    <span class="custom-control-indicator"></span>
    <span class="custom-control-description">Check this custom checkbox</span>
  </label>
</div>
<div class="form-group has-warning">
  <label class="custom-control custom-checkbox">
    <input type="checkbox" class="custom-control-input">
    <span class="custom-control-indicator"></span>
    <span class="custom-control-description">Check this custom checkbox</span>
  </label>
</div>
939
<div class="form-group has-danger mb-0">
940
941
942
943
944
945
946
  <label class="custom-control custom-checkbox">
    <input type="checkbox" class="custom-control-input">
    <span class="custom-control-indicator"></span>
    <span class="custom-control-description">Check this custom checkbox</span>
  </label>
</div>
{% endexample %}
Mark Otto's avatar
Mark Otto committed
947

948
949
#### Stacked

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

{% example html %}
Mark Otto's avatar
Mark Otto committed
953
954
955
956
957
<div class="custom-controls-stacked">
  <label class="custom-control custom-radio">
    <input id="radioStacked1" name="radio-stacked" type="radio" class="custom-control-input">
    <span class="custom-control-indicator"></span>
    <span class="custom-control-description">Toggle this custom radio</span>
958
  </label>
Mark Otto's avatar
Mark Otto committed
959
960
961
962
  <label class="custom-control custom-radio">
    <input id="radioStacked2" name="radio-stacked" type="radio" class="custom-control-input">
    <span class="custom-control-indicator"></span>
    <span class="custom-control-description">Or toggle this other custom radio</span>
963
964
965
966
967
968
  </label>
</div>
{% endexample %}

### Select menu

969
Custom `<select>` menus need only a custom class, `.custom-select` to trigger the custom styles.
970
971

{% example html %}
972
<select class="custom-select">
973
974
975
976
977
  <option selected>Open this select menu</option>
  <option value="1">One</option>
  <option value="2">Two</option>
  <option value="3">Three</option>
</select>
978
979
980
981
{% endexample %}

### File browser

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

984
{% example html %}
985
986
987
<label class="custom-file">
  <input type="file" id="file" class="custom-file-input">
  <span class="custom-file-control"></span>
988
989
990
</label>
{% endexample %}

991
Here's how it works:
992
993
994
995
996
997
998
999

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

In other words, it's an entirely custom element, all generated via CSS.
1000

For faster browsing, not all history is shown. View entire blame