forms.md 38 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
4
group: components
Mark Otto's avatar
Mark Otto committed
5
6
---

7
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
8

Mark Otto's avatar
Mark Otto committed
9
10
11
12
13
## Contents

* Will be replaced with the ToC, excluding the "Contents" header
{:toc}

14
## Form controls
Mark Otto's avatar
Mark Otto committed
15

16
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
17

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

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

91
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.
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120

<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>
121
        {% markdown %}`text`, `password`, `datetime-local`, `date`, `month`, `time`, `week`, `number`, `email`, `url`, `search`, `tel`, `color`{% endmarkdown %}
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
      </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 %}
154
155
`.form-check`<br>
`.form-check-inline`
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
  <label for="example-text-input" class="col-xs-2 col-form-label">Text</label>
175
176
177
178
179
  <div class="col-xs-10">
    <input class="form-control" type="text" value="Artisanal kale" id="example-text-input">
  </div>
</div>
<div class="form-group row">
180
  <label for="example-search-input" class="col-xs-2 col-form-label">Search</label>
181
182
183
184
185
  <div class="col-xs-10">
    <input class="form-control" type="search" value="How do I shoot web" id="example-search-input">
  </div>
</div>
<div class="form-group row">
186
  <label for="example-email-input" class="col-xs-2 col-form-label">Email</label>
187
188
189
190
191
  <div class="col-xs-10">
    <input class="form-control" type="email" value="bootstrap@example.com" id="example-email-input">
  </div>
</div>
<div class="form-group row">
192
  <label for="example-url-input" class="col-xs-2 col-form-label">URL</label>
193
194
195
196
197
  <div class="col-xs-10">
    <input class="form-control" type="url" value="http://getbootstrap.com" id="example-url-input">
  </div>
</div>
<div class="form-group row">
198
  <label for="example-tel-input" class="col-xs-2 col-form-label">Telephone</label>
199
200
201
202
203
  <div class="col-xs-10">
    <input class="form-control" type="tel" value="1-(555)-555-5555" id="example-tel-input">
  </div>
</div>
<div class="form-group row">
204
  <label for="example-password-input" class="col-xs-2 col-form-label">Password</label>
205
206
207
208
209
  <div class="col-xs-10">
    <input class="form-control" type="password" value="hunter2" id="example-password-input">
  </div>
</div>
<div class="form-group row">
210
  <label for="example-number-input" class="col-xs-2 col-form-label">Number</label>
211
212
213
214
215
  <div class="col-xs-10">
    <input class="form-control" type="number" value="42" id="example-number-input">
  </div>
</div>
<div class="form-group row">
216
  <label for="example-datetime-local-input" class="col-xs-2 col-form-label">Date and time</label>
217
218
219
220
221
  <div class="col-xs-10">
    <input class="form-control" type="datetime-local" value="2011-08-19T13:45:00" id="example-datetime-local-input">
  </div>
</div>
<div class="form-group row">
222
  <label for="example-date-input" class="col-xs-2 col-form-label">Date</label>
223
224
225
226
227
  <div class="col-xs-10">
    <input class="form-control" type="date" value="2011-08-19" id="example-date-input">
  </div>
</div>
<div class="form-group row">
228
  <label for="example-month-input" class="col-xs-2 col-form-label">Month</label>
229
230
231
232
233
  <div class="col-xs-10">
    <input class="form-control" type="month" value="2011-08" id="example-month-input">
  </div>
</div>
<div class="form-group row">
234
  <label for="example-week-input" class="col-xs-2 col-form-label">Week</label>
235
236
237
238
239
  <div class="col-xs-10">
    <input class="form-control" type="week" value="2011-W33" id="example-week-input">
  </div>
</div>
<div class="form-group row">
240
  <label for="example-time-input" class="col-xs-2 col-form-label">Time</label>
241
242
243
244
245
  <div class="col-xs-10">
    <input class="form-control" type="time" value="13:45:00" id="example-time-input">
  </div>
</div>
<div class="form-group row">
246
  <label for="example-color-input" class="col-xs-2 col-form-label">Color</label>
247
248
249
250
251
252
  <div class="col-xs-10">
    <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">
264
    <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">
268
    <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

cndpzc's avatar
cndpzc committed
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 behave differently:
277
278
279
280

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

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

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

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

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

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

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

335
{% callout warning %}
Mark Otto's avatar
Mark Otto committed
336
337
338
#### 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 %}
339

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

342
For more structured form layouts that are also responsive, you can utilize Bootstrap's [predefined grid classes](/layout/grid/#predefined-classes) or [mixins](/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
343

344
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
345
346

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

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

{% example html %}
<div class="container">
  <form>
    <div class="form-group row">
409
      <label for="lgFormGroupInput" class="col-sm-2 col-form-label col-form-label-lg">Email</label>
410
411
      <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
412
      </div>
413
    </div>
414
    <div class="form-group row">
415
      <label for="smFormGroupInput" class="col-sm-2 col-form-label col-form-label-sm">Email</label>
416
417
418
      <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
419
    </div>
420
421
  </form>
</div>
Mark Otto's avatar
Mark Otto committed
422
{% endexample %}
Mark Otto's avatar
Mark Otto committed
423

424

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

Mark Otto's avatar
Mark Otto committed
427
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
428

429
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
430

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

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

450
{% example html %}
Mark Otto's avatar
Mark Otto committed
451
452
453
<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
454
455
456
    Option one is this and that&mdash;be sure to include why it's great
  </label>
</div>
Mark Otto's avatar
Mark Otto committed
457
458
459
<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
460
461
462
    Option two can be something else and selecting it will deselect option one
  </label>
</div>
Mark Otto's avatar
Mark Otto committed
463
464
465
<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
466
467
468
    Option three is disabled
  </label>
</div>
Mark Otto's avatar
Mark Otto committed
469
{% endexample %}
Mark Otto's avatar
Mark Otto committed
470

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

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

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

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

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

501
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
502
503

{% example html %}
Mark Otto's avatar
Mark Otto committed
504
505
506
<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
507
508
  </label>
</div>
Mark Otto's avatar
Mark Otto committed
509
510
511
<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
512
513
514
515
  </label>
</div>
{% endexample %}

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

Mark Otto's avatar
Mark Otto committed
518
When you need to place plain text next to a form label within a form, use the `.form-control-static` class on a `<p>`.
Mark Otto's avatar
Mark Otto committed
519
520

{% example html %}
521
<form>
522
  <div class="form-group row">
523
    <label class="col-sm-2 col-form-label">Email</label>
Mark Otto's avatar
Mark Otto committed
524
525
526
527
    <div class="col-sm-10">
      <p class="form-control-static">email@example.com</p>
    </div>
  </div>
528
  <div class="form-group row">
529
    <label for="inputPassword" class="col-sm-2 col-form-label">Password</label>
Mark Otto's avatar
Mark Otto committed
530
531
532
533
534
    <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
535
{% endexample %}
Mark Otto's avatar
Mark Otto committed
536

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

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

Mark Otto's avatar
Mark Otto committed
553
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
554
555

{% highlight html %}
Mark Otto's avatar
Mark Otto committed
556
557
558
559
560
561
<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
562
<form>
Mark Otto's avatar
Mark Otto committed
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
  <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
582
{% endexample %}
Mark Otto's avatar
Mark Otto committed
583

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

587
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](../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.
588
589
590
591
592
593
594
{% 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
595
596
597

## Readonly inputs

598
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
599
600

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

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

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

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

{% example html %}
615
616
617
618
619
620
621
622
623
<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
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
{% endexample %}

## Column sizing

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

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

## Help text

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

648
649
650
651
652
653
{% 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 %}

654
655
656
657
658
659
660
661
662
663
664
665
666
667
### 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
668
Inline text can use any typical inline HTML element (be it a `<small>`, `<span>`, or something else).
Mark Otto's avatar
Mark Otto committed
669
670

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

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

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

686
- 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.
687
- 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.
688
689
- 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.
690
- 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
691

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

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

Here are some examples of the aforementioned classes in action.

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

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

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

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

752
753
## Custom forms

754
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.
755
756
757
758
759
760
761
762
763

### 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
764
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.
765

Mark Otto's avatar
Mark Otto committed
766
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.
767

XhmikosR's avatar
XhmikosR committed
768
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.
769
770
771
772

#### Checkboxes

{% example html %}
Mark Otto's avatar
Mark Otto committed
773
774
775
776
<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>
777
778
779
</label>
{% endexample %}

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

<div class="bd-example bd-example-indeterminate">
Mark Otto's avatar
Mark Otto committed
783
784
785
786
  <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>
787
788
789
  </label>
</div>

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

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

#### Radios

{% example html %}
Mark Otto's avatar
Mark Otto committed
799
800
801
802
<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>
803
</label>
Mark Otto's avatar
Mark Otto committed
804
805
806
807
<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>
808
809
810
</label>
{% endexample %}

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

Mark Otto's avatar
Mark Otto committed
813
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
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828

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

829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
#### 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>
<div class="form-group has-danger m-b-0">
  <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
856

857
858
#### Stacked

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

{% example html %}
Mark Otto's avatar
Mark Otto committed
862
863
864
865
866
<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>
867
  </label>
Mark Otto's avatar
Mark Otto committed
868
869
870
871
  <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>
872
873
874
875
876
877
  </label>
</div>
{% endexample %}

### Select menu

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

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

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

### File browser

893
894
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.

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

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

- 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.
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929

#### Translating or customizing the strings

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

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

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