forms.md 36 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
25
    <input type="email" class="form-control" id="exampleInputEmail1" aria-describedby="emailHelp" placeholder="Enter email">
    <small id="emailHelp" class="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
58
    <input type="file" class="form-control-file" id="exampleInputFile" aria-describedby="fileHelp">
    <small id="fileHelp" class="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
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
  <fieldset class="form-group">
    <legend>Radio buttons</legend>
    <div class="radio">
      <label>
        <input type="radio" name="optionsRadios" id="optionsRadios1" value="option1" checked>
        Option one is this and that&mdash;be sure to include why it's great
      </label>
    </div>
    <div class="radio">
      <label>
        <input type="radio" name="optionsRadios" id="optionsRadios2" value="option2">
        Option two can be something else and selecting it will deselect option one
      </label>
    </div>
    <div class="radio disabled">
      <label>
        <input type="radio" name="optionsRadios" id="optionsRadios3" value="option3" disabled>
        Option three is disabled
      </label>
    </div>
  </fieldset>
Mark Otto's avatar
Mark Otto committed
81
82
83
84
85
  <div class="checkbox">
    <label>
      <input type="checkbox"> Check me out
    </label>
  </div>
Mark Otto's avatar
Mark Otto committed
86
  <button type="submit" class="btn btn-primary">Submit</button>
Mark Otto's avatar
Mark Otto committed
87
</form>
Mark Otto's avatar
Mark Otto committed
88
{% endexample %}
Mark Otto's avatar
Mark Otto committed
89

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

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

169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
### Textual inputs

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

{% example html %}
<div class="form-group row">
  <label for="example-text-input" class="col-xs-2 form-control-label">Text</label>
  <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">
  <label for="example-search-input" class="col-xs-2 form-control-label">Search</label>
  <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">
  <label for="example-email-input" class="col-xs-2 form-control-label">Email</label>
  <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">
  <label for="example-url-input" class="col-xs-2 form-control-label">URL</label>
  <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">
  <label for="example-tel-input" class="col-xs-2 form-control-label">Telephone</label>
  <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">
  <label for="example-password-input" class="col-xs-2 form-control-label">Password</label>
  <div class="col-xs-10">
    <input class="form-control" type="password" value="hunter2" id="example-password-input">
  </div>
</div>
<div class="form-group row">
  <label for="example-number-input" class="col-xs-2 form-control-label">Number</label>
  <div class="col-xs-10">
    <input class="form-control" type="number" value="42" id="example-number-input">
  </div>
</div>
<div class="form-group row">
  <label for="example-datetime-local-input" class="col-xs-2 form-control-label">Date and time</label>
  <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">
  <label for="example-date-input" class="col-xs-2 form-control-label">Date</label>
  <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">
  <label for="example-month-input" class="col-xs-2 form-control-label">Month</label>
  <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">
  <label for="example-week-input" class="col-xs-2 form-control-label">Week</label>
  <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">
  <label for="example-time-input" class="col-xs-2 form-control-label">Time</label>
  <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">
  <label for="example-color-input" class="col-xs-2 form-control-label">Color</label>
  <div class="col-xs-10">
    <input class="form-control" type="color" value="#563d7c" id="example-color-input">
  </div>
</div>
{% endexample %}

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

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

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

### Inline forms

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

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

Chris Rebert's avatar
Chris Rebert committed
283
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
284

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

{% example html %}
288
289
290
291
292
293
294
295
296
297
298
<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
299
300
{% endexample %}

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

Mark Otto's avatar
Mark Otto committed
303
{% example html %}
Mark Otto's avatar
Mark Otto committed
304
<form class="form-inline">
Mark Otto's avatar
Mark Otto committed
305
  <div class="form-group">
Mark Otto's avatar
Mark Otto committed
306
307
    <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
308
309
  </div>
  <div class="form-group">
Mark Otto's avatar
Mark Otto committed
310
311
    <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
312
313
314
315
316
317
  </div>
  <div class="checkbox">
    <label>
      <input type="checkbox"> Remember me
    </label>
  </div>
Mark Otto's avatar
Mark Otto committed
318
  <button type="submit" class="btn btn-primary">Sign in</button>
Mark Otto's avatar
Mark Otto committed
319
320
321
322
323
324
325
326
327
328
329
330
331
332
</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
333
</form>
Mark Otto's avatar
Mark Otto committed
334
{% endexample %}
Mark Otto's avatar
Mark Otto committed
335

336
337
338
339
340
{% callout warning %}
 #### 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 %}

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

343
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
344

345
Be sure to add `.form-control-label` to your `<label>`s as well so they're vertically centered with their associated form controls. For `<legend>` elements, you can use `.form-control-legend` to make them appear similar to regular `<label>` elements.
Mark Otto's avatar
Mark Otto committed
346
347

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

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

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

423

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

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
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 <code>.disabled</code> class to the parent `.radio`, `.radio-inline`, `.checkbox`, or `.checkbox-inline`.
Mark Otto's avatar
Mark Otto committed
429

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

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

<div class="radio">
  <label>
448
    <input type="radio" name="exampleRadios" id="exampleRadios1" value="option1" checked>
Mark Otto's avatar
Mark Otto committed
449
450
451
452
453
    Option one is this and that&mdash;be sure to include why it's great
  </label>
</div>
<div class="radio">
  <label>
454
    <input type="radio" name="exampleRadios" id="exampleRadios2" value="option2">
Mark Otto's avatar
Mark Otto committed
455
456
457
    Option two can be something else and selecting it will deselect option one
  </label>
</div>
Chris Rebert's avatar
Chris Rebert committed
458
459
<div class="radio disabled">
  <label>
460
    <input type="radio" name="exampleRadios" id="exampleRadios3" value="option3" disabled>
Chris Rebert's avatar
Chris Rebert committed
461
462
463
    Option three is disabled
  </label>
</div>
Mark Otto's avatar
Mark Otto committed
464
{% endexample %}
Mark Otto's avatar
Mark Otto committed
465

466
### Inline
Mark Otto's avatar
Mark Otto committed
467
468
469
470

Use the `.checkbox-inline` or `.radio-inline` classes on a series of checkboxes or radios for controls that appear on the same line.

{% example html %}
Mark Otto's avatar
Mark Otto committed
471
472
473
474
475
476
477
478
479
<label class="checkbox-inline">
  <input type="checkbox" id="inlineCheckbox1" value="option1"> 1
</label>
<label class="checkbox-inline">
  <input type="checkbox" id="inlineCheckbox2" value="option2"> 2
</label>
<label class="checkbox-inline">
  <input type="checkbox" id="inlineCheckbox3" value="option3"> 3
</label>
480
{% endexample %}
Mark Otto's avatar
Mark Otto committed
481

482
{% example html %}
Mark Otto's avatar
Mark Otto committed
483
484
485
486
487
488
489
490
491
<label class="radio-inline">
  <input type="radio" name="inlineRadioOptions" id="inlineRadio1" value="option1"> 1
</label>
<label class="radio-inline">
  <input type="radio" name="inlineRadioOptions" id="inlineRadio2" value="option2"> 2
</label>
<label class="radio-inline">
  <input type="radio" name="inlineRadioOptions" id="inlineRadio3" value="option3"> 3
</label>
Mark Otto's avatar
Mark Otto committed
492
{% endexample %}
Mark Otto's avatar
Mark Otto committed
493

494
### Without labels
Mark Otto's avatar
Mark Otto committed
495

496
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
497
498
499
500

{% example html %}
<div class="checkbox">
  <label>
501
    <input type="checkbox" id="blankCheckbox" value="option1" aria-label="...">
Mark Otto's avatar
Mark Otto committed
502
503
504
505
  </label>
</div>
<div class="radio">
  <label>
506
    <input type="radio" name="blankRadio" id="blankRadio1" value="option1" aria-label="...">
Mark Otto's avatar
Mark Otto committed
507
508
509
510
  </label>
</div>
{% endexample %}

Mark Otto's avatar
Mark Otto committed
511
## Static controls
Mark Otto's avatar
Mark Otto committed
512

Mark Otto's avatar
Mark Otto committed
513
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
514
515

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

Mark Otto's avatar
Mark Otto committed
532
{% example html %}
Mark Otto's avatar
Mark Otto committed
533
<form class="form-inline">
Mark Otto's avatar
Mark Otto committed
534
535
536
537
538
539
540
541
  <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
542
  <button type="submit" class="btn btn-primary">Confirm identity</button>
Mark Otto's avatar
Mark Otto committed
543
544
545
</form>
{% endexample %}

Mark Otto's avatar
Mark Otto committed
546
## Disabled states
Mark Otto's avatar
Mark Otto committed
547

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

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

579
580
{% callout warning %}
#### Caveat about link functionality of `<a>`
Mark Otto's avatar
Mark Otto committed
581

582
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.
583
584
585
586
587
588
589
{% 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
590
591
592

## Readonly inputs

593
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
594
595

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

Mark Otto's avatar
Mark Otto committed
599
600
601
602
603
## Control sizing

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

{% example html %}
604
<input class="form-control form-control-lg" type="text" placeholder=".form-control-lg">
Mark Otto's avatar
Mark Otto committed
605
<input class="form-control" type="text" placeholder="Default input">
606
<input class="form-control form-control-sm" type="text" placeholder=".form-control-sm">
Mark Otto's avatar
Mark Otto committed
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
{% endexample %}

{% example html %}
<select class="form-control form-control-lg"></select>
<select class="form-control"></select>
<select class="form-control form-control-sm"></select>
{% 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

Mark Otto's avatar
Mark Otto committed
635
No official classes exist in Bootstrap 4 for stylizing help text (previously we had `.help-block` in v3), but thanks to utility classes like `.text-muted`, you can create much more flexible help text as needed.
Mark Otto's avatar
Mark Otto committed
636

637
638
639
640
641
642
{% 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 %}

Mark Otto's avatar
Mark Otto committed
643
Inline text can use any typical inline HTML element (be it a `<small>`, `<span>`, or something else).
Mark Otto's avatar
Mark Otto committed
644
645

{% example html %}
646
647
648
649
650
651
652
653
654
<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>
655
656
{% endexample %}

Mark Otto's avatar
Mark Otto committed
657
658
Block help text—for below inputs or for longer lines of help text—can be easily achieved with a `<p>`.

659
{% example html %}
660
661
662
<label for="inputPassword5">Password</label>
<input type="password" id="inputPassword5" class="form-control" aria-describedby="passwordHelpBlock">
<p id="passwordHelpBlock" class="text-muted">
Mark Otto's avatar
Mark Otto committed
663
  Your password must be 8-20 characters long, contain letters and numbers, and must not contain spaces, special characters or emoji.
664
</p>
Mark Otto's avatar
Mark Otto committed
665
666
{% endexample %}

Mark Otto's avatar
Mark Otto committed
667
## Validation
Mark Otto's avatar
Mark Otto committed
668

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

671
672
- To use, add `.has-warning`, `.has-danger`, or `.has-success` to the parent element. Any `.form-control-label`, `.form-control`, or custom form element will receive the validation styles.
- 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.
673
674
- 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.
675
- 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
676

Mark Otto's avatar
Mark Otto committed
677
678
679
680
681
682
683
684
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.

685
{% comment %}
686
687
688
689
690
691
692
{% 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 %}
693
{% endcomment %}
Mark Otto's avatar
Mark Otto committed
694

Mark Otto's avatar
Mark Otto committed
695
{% example html %}
Mark Otto's avatar
Mark Otto committed
696
<div class="form-group has-success">
697
  <label class="form-control-label" for="inputSuccess1">Input with success</label>
698
  <input type="text" class="form-control form-control-success" id="inputSuccess1">
Mark Otto's avatar
Mark Otto committed
699
700
  <div class="form-control-feedback">Success! You've done it.</div>
  <small class="text-muted">Example help text that remains unchanged.</small>
Mark Otto's avatar
Mark Otto committed
701
702
</div>
<div class="form-group has-warning">
703
  <label class="form-control-label" for="inputWarning1">Input with warning</label>
704
  <input type="text" class="form-control form-control-warning" id="inputWarning1">
Mark Otto's avatar
Mark Otto committed
705
706
  <div class="form-control-feedback">Shucks, check the formatting of that and try again.</div>
  <small class="text-muted">Example help text that remains unchanged.</small>
Mark Otto's avatar
Mark Otto committed
707
</div>
708
<div class="form-group has-danger">
Mark Otto's avatar
Mark Otto committed
709
710
  <label class="form-control-label" for="inputDanger1">Input with danger</label>
  <input type="text" class="form-control form-control-danger" id="inputDanger1">
Mark Otto's avatar
Mark Otto committed
711
712
  <div class="form-control-feedback">Shit, that username's taken. Try another?</div>
  <small class="text-muted">Example help text that remains unchanged.</small>
Mark Otto's avatar
Mark Otto committed
713
</div>
Mark Otto's avatar
Mark Otto committed
714
{% endexample %}
715

Mark Otto's avatar
Mark Otto committed
716
{% example html %}
717
718
719
720
721
<div class="checkbox has-success">
  <label>
    <input type="checkbox" id="checkboxSuccess" value="option1">
    Checkbox with success
  </label>
722
</div>
723
724
725
726
727
<div class="checkbox has-warning">
  <label>
    <input type="checkbox" id="checkboxWarning" value="option1">
    Checkbox with warning
  </label>
Mark Otto's avatar
Mark Otto committed
728
</div>
729
730
<div class="checkbox has-danger">
  <label>
Mark Otto's avatar
Mark Otto committed
731
732
    <input type="checkbox" id="checkboxDanger" value="option1">
    Checkbox with danger
733
  </label>
734
</div>
Mark Otto's avatar
Mark Otto committed
735
{% endexample %}
Mark Otto's avatar
Mark Otto committed
736

737
738
## Custom forms

739
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.
740
741
742
743
744
745
746
747
748

### 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
749
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.
750

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

XhmikosR's avatar
XhmikosR committed
753
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.
754
755
756
757

#### Checkboxes

{% example html %}
Mark Otto's avatar
Mark Otto committed
758
759
760
761
<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>
762
763
764
</label>
{% endexample %}

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

<div class="bd-example bd-example-indeterminate">
Mark Otto's avatar
Mark Otto committed
768
769
770
771
  <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>
772
773
774
  </label>
</div>

Mark Otto's avatar
Mark Otto committed
775
If you're using jQuery, something like this should suffice:
776
777
778
779
780
781
782
783

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

#### Radios

{% example html %}
Mark Otto's avatar
Mark Otto committed
784
785
786
787
<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>
788
</label>
Mark Otto's avatar
Mark Otto committed
789
790
791
792
<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>
793
794
795
</label>
{% endexample %}

Mark Otto's avatar
Mark Otto committed
796
797
#### Disabled

Mark Otto's avatar
Mark Otto committed
798
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
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813

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

814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
#### 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
841

842
843
#### Stacked

Mark Otto's avatar
Mark Otto committed
844
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.
845
846

{% example html %}
Mark Otto's avatar
Mark Otto committed
847
848
849
850
851
<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>
852
  </label>
Mark Otto's avatar
Mark Otto committed
853
854
855
856
  <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>
857
858
859
860
861
862
  </label>
</div>
{% endexample %}

### Select menu

863
Custom `<select>` menus need only a custom class, `.custom-select` to trigger the custom styles.
864
865

{% example html %}
866
<select class="custom-select">
867
868
869
870
871
  <option selected>Open this select menu</option>
  <option value="1">One</option>
  <option value="2">Two</option>
  <option value="3">Three</option>
</select>
872
873
{% endexample %}

874
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.**
875
876
877

### File browser

878
879
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.

880
{% example html %}
881
882
883
<label class="custom-file">
  <input type="file" id="file" class="custom-file-input">
  <span class="custom-file-control"></span>
884
885
886
</label>
{% endexample %}

887
Here's how it works:
888
889
890
891
892
893
894
895

- 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.
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914

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