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
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
Remember, since Bootstrap utilizes the HTML5 doctype, **all inputs must have a `type` attribute**.
20

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

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

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

168
169
170
171
172
173
### Textual inputs

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

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

253
254
255
256
257
258
## 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

259
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
260

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

### Inline forms

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

278
- 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.
279
280
- 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
281

282
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
283
284

{% example html %}
285
<form class="form-inline">
286
287
  <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
288

289
290
291
292
  <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
293
  </div>
294
295

  <div class="form-check mb-2 mr-sm-2 mb-sm-0">
296
297
    <label class="form-check-label">
      <input class="form-check-input" type="checkbox"> Remember me
Mark Otto's avatar
Mark Otto committed
298
299
    </label>
  </div>
300
301

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

305
306
Custom form controls and selects are also supported.

Mark Otto's avatar
Mark Otto committed
307
308
{% example html %}
<form class="form-inline">
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
  <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
324
</form>
Mark Otto's avatar
Mark Otto committed
325
{% endexample %}
Mark Otto's avatar
Mark Otto committed
326

327
{% callout warning %}
Mark Otto's avatar
Mark Otto committed
328
329
330
#### 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 %}
331

332
### Using the Grid
Mark Otto's avatar
Mark Otto committed
333

Bardi Harborow's avatar
Bardi Harborow committed
334
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
335

336
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
337
338

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

Mark Otto's avatar
Mark Otto committed
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
440
441
442
443
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 %}

444
445
446
447
448
449
Grid-based form layouts also support large and small inputs.

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

465
## Checkboxes and radios
Mark Otto's avatar
Mark Otto committed
466

Mark Otto's avatar
Mark Otto committed
467
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
468

469
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
470

471
### Default (stacked)
Mark Otto's avatar
Mark Otto committed
472

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

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

511
### Inline
Mark Otto's avatar
Mark Otto committed
512

513
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
514
515

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

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

551
### Without labels
Mark Otto's avatar
Mark Otto committed
552

553
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
554
555

{% example html %}
Mark Otto's avatar
Mark Otto committed
556
557
558
<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
559
560
  </label>
</div>
Mark Otto's avatar
Mark Otto committed
561
562
563
<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
564
565
566
567
  </label>
</div>
{% endexample %}

Mark Otto's avatar
Mark Otto committed
568
## Static controls
Mark Otto's avatar
Mark Otto committed
569

570
When you need to place plain text next to a form label within a form, use the `.form-control-static` class on an element of your choice.
Mark Otto's avatar
Mark Otto committed
571
572

{% example html %}
573
<form>
574
  <div class="form-group row">
575
    <label class="col-sm-2 col-form-label">Email</label>
Mark Otto's avatar
Mark Otto committed
576
    <div class="col-sm-10">
577
      <p class="form-control-static">email@example.com</p>
Mark Otto's avatar
Mark Otto committed
578
579
    </div>
  </div>
580
  <div class="form-group row">
581
    <label for="inputPassword" class="col-sm-2 col-form-label">Password</label>
Mark Otto's avatar
Mark Otto committed
582
583
584
585
586
    <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
587
{% endexample %}
Mark Otto's avatar
Mark Otto committed
588

Mark Otto's avatar
Mark Otto committed
589
{% example html %}
Mark Otto's avatar
Mark Otto committed
590
<form class="form-inline">
Mark Otto's avatar
Mark Otto committed
591
592
  <div class="form-group">
    <label class="sr-only">Email</label>
593
    <p class="form-control-static">email@example.com</p>
Mark Otto's avatar
Mark Otto committed
594
  </div>
595
  <div class="form-group mx-sm-3">
Mark Otto's avatar
Mark Otto committed
596
597
598
    <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
599
  <button type="submit" class="btn btn-primary">Confirm identity</button>
Mark Otto's avatar
Mark Otto committed
600
601
602
</form>
{% endexample %}

Mark Otto's avatar
Mark Otto committed
603
## Disabled states
Mark Otto's avatar
Mark Otto committed
604

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

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

636
637
{% callout warning %}
#### Caveat about link functionality of `<a>`
Mark Otto's avatar
Mark Otto committed
638

639
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.
640
641
642
643
644
645
646
{% 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
647
648
649

## Readonly inputs

650
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
651
652

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

Mark Otto's avatar
Mark Otto committed
656
657
658
659
660
## Control sizing

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

{% example html %}
661
<input class="form-control form-control-lg" type="text" placeholder=".form-control-lg">
Mark Otto's avatar
Mark Otto committed
662
<input class="form-control" type="text" placeholder="Default input">
663
<input class="form-control form-control-sm" type="text" placeholder=".form-control-sm">
Mark Otto's avatar
Mark Otto committed
664
665
666
{% endexample %}

{% example html %}
667
668
669
670
671
672
673
674
675
<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
676
677
678
679
680
681
682
683
{% endexample %}

## Column sizing

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

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

## Help text

698
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
699

700
701
702
703
704
705
{% 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 %}

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

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

Mark Otto's avatar
Mark Otto committed
734
## Validation
Mark Otto's avatar
Mark Otto committed
735

Mark Otto's avatar
Mark Otto committed
736
737
738
739
740
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:
741

742
- 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.
743
- 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.
744
745
- 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.
746
- 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
747

Mark Otto's avatar
Mark Otto committed
748
749
### Defining states

Mark Otto's avatar
Mark Otto committed
750
751
752
753
754
755
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.

756
{% comment %}
757
758
759
760
761
{% 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.

762
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.
763
{% endcallout %}
764
{% endcomment %}
Mark Otto's avatar
Mark Otto committed
765

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

Mark Otto's avatar
Mark Otto committed
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
822
823
824
825
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
826
{% example html %}
827
828
829
<div class="form-check has-success">
  <label class="form-check-label">
    <input type="checkbox" class="form-check-input" id="checkboxSuccess" value="option1">
830
831
    Checkbox with success
  </label>
832
</div>
833
834
835
<div class="form-check has-warning">
  <label class="form-check-label">
    <input type="checkbox" class="form-check-input" id="checkboxWarning" value="option1">
836
837
    Checkbox with warning
  </label>
Mark Otto's avatar
Mark Otto committed
838
</div>
839
840
841
<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
842
    Checkbox with danger
843
  </label>
844
</div>
Mark Otto's avatar
Mark Otto committed
845
{% endexample %}
Mark Otto's avatar
Mark Otto committed
846

847
848
## Custom forms

849
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.
850
851
852
853
854
855
856
857
858

### 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
859
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.
860

Mark Otto's avatar
Mark Otto committed
861
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.
862

XhmikosR's avatar
XhmikosR committed
863
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.
864
865
866
867

#### Checkboxes

{% example html %}
Mark Otto's avatar
Mark Otto committed
868
869
870
871
<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>
872
873
874
</label>
{% endexample %}

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

<div class="bd-example bd-example-indeterminate">
Mark Otto's avatar
Mark Otto committed
878
879
880
881
  <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>
882
883
884
  </label>
</div>

Mark Otto's avatar
Mark Otto committed
885
If you're using jQuery, something like this should suffice:
886
887
888
889
890
891
892
893

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

#### Radios

{% example html %}
Mark Otto's avatar
Mark Otto committed
894
895
896
897
<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>
898
</label>
Mark Otto's avatar
Mark Otto committed
899
900
901
902
<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>
903
904
905
</label>
{% endexample %}

Mark Otto's avatar
Mark Otto committed
906
907
#### Disabled

Mark Otto's avatar
Mark Otto committed
908
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
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923

{% 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 %}

924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
#### 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>
943
<div class="form-group has-danger mb-0">
944
945
946
947
948
949
950
  <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
951

952
953
#### Stacked

Mark Otto's avatar
Mark Otto committed
954
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.
955
956

{% example html %}
Mark Otto's avatar
Mark Otto committed
957
958
959
960
961
<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>
962
  </label>
Mark Otto's avatar
Mark Otto committed
963
964
965
966
  <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>
967
968
969
970
971
972
  </label>
</div>
{% endexample %}

### Select menu

973
Custom `<select>` menus need only a custom class, `.custom-select` to trigger the custom styles.
974
975

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

### File browser

986
987
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.

988
{% example html %}
989
990
991
<label class="custom-file">
  <input type="file" id="file" class="custom-file-input">
  <span class="custom-file-control"></span>
992
993
994
</label>
{% endexample %}

995
Here's how it works:
996
997
998
999
1000

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