forms.md 24.7 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](/components/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
  <fieldset class="form-group">
Mark Otto's avatar
Mark Otto committed
23
24
    <label for="exampleInputEmail1">Email address</label>
    <input type="email" class="form-control" id="exampleInputEmail1" placeholder="Enter email">
Mark Otto's avatar
Mark Otto committed
25
    <small class="text-muted">We'll never share your email with anyone else.</small>
26
27
  </fieldset>
  <fieldset 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
32
  </fieldset>
  <fieldset class="form-group">
    <label for="exampleSelect1">Example select</label>
33
    <select class="form-control" id="exampleSelect1">
34
35
36
37
38
39
40
41
42
      <option>1</option>
      <option>2</option>
      <option>3</option>
      <option>4</option>
      <option>5</option>
    </select>
  </fieldset>
  <fieldset class="form-group">
    <label for="exampleSelect2">Example multiple select</label>
43
    <select multiple class="form-control" id="exampleSelect2">
44
45
46
47
48
49
50
51
52
53
54
55
      <option>1</option>
      <option>2</option>
      <option>3</option>
      <option>4</option>
      <option>5</option>
    </select>
  </fieldset>
  <fieldset class="form-group">
    <label for="exampleTextarea">Example textarea</label>
    <textarea class="form-control" id="exampleTextarea" rows="3"></textarea>
  </fieldset>
  <fieldset class="form-group">
Mark Otto's avatar
Mark Otto committed
56
    <label for="exampleInputFile">File input</label>
Mark Otto's avatar
Mark Otto committed
57
    <input type="file" class="form-control-file" id="exampleInputFile">
Mark Otto's avatar
Mark Otto committed
58
    <small 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>
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
  </fieldset>
  <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>
Mark Otto's avatar
Mark Otto committed
77
78
79
80
81
82
  </div>
  <div class="checkbox">
    <label>
      <input type="checkbox"> Check me out
    </label>
  </div>
Mark Otto's avatar
Mark Otto committed
83
  <button type="submit" class="btn btn-primary">Submit</button>
Mark Otto's avatar
Mark Otto committed
84
</form>
Mark Otto's avatar
Mark Otto committed
85
{% endexample %}
Mark Otto's avatar
Mark Otto committed
86

87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
Below is a complete list of the specific from controls supported by Bootstrap and the classes that customize them. Additional documentation is available for each group.

<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>
        {% markdown %}`text`, `password`, `datetime`, `datetime-local`, `date`, `month`, `time`, `week`, `number`, `email`, `url`, `search`, `tel`, `color`{% endmarkdown %}
      </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>

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

The `.form-group` class is the easiest way to add some structure to forms. It's 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
173

174
175
176
{% example html %}
<form>
  <fieldset class="form-group">
177
    <label for="formGroupExampleInput">Example label</label>
178
179
180
    <input type="text" class="form-control" id="formGroupExampleInput" placeholder="Example input">
  </fieldset>
  <fieldset class="form-group">
181
    <label for="formGroupExampleInput2">Another label</label>
182
183
184
185
186
187
188
189
190
191
192
193
    <input type="text" class="form-control" id="formGroupExampleInput2" placeholder="Another input">
  </fieldset>
</form>
{% endexample %}

### Inline forms

Use the `.inline-form` class to to display a series of labels, form controls, and buttons on a single horizontal row. Form controls within inline forms behave differently:

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

Chris Rebert's avatar
Chris Rebert committed
195
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
196

197
#### Visible labels
Mark Otto's avatar
Mark Otto committed
198
199

{% example html %}
200
201
202
203
204
205
206
207
208
209
210
<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
211
212
{% endexample %}

213
#### Hidden labels
Mark Otto's avatar
Mark Otto committed
214

Mark Otto's avatar
Mark Otto committed
215
{% example html %}
Mark Otto's avatar
Mark Otto committed
216
<form class="form-inline">
Mark Otto's avatar
Mark Otto committed
217
  <div class="form-group">
Mark Otto's avatar
Mark Otto committed
218
219
    <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
220
221
  </div>
  <div class="form-group">
Mark Otto's avatar
Mark Otto committed
222
223
    <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
224
225
226
227
228
229
  </div>
  <div class="checkbox">
    <label>
      <input type="checkbox"> Remember me
    </label>
  </div>
Mark Otto's avatar
Mark Otto committed
230
  <button type="submit" class="btn btn-primary">Sign in</button>
Mark Otto's avatar
Mark Otto committed
231
232
233
234
235
236
237
238
239
240
241
242
243
244
</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
245
</form>
Mark Otto's avatar
Mark Otto committed
246
{% endexample %}
Mark Otto's avatar
Mark Otto committed
247

248
### Using the Grid
Mark Otto's avatar
Mark Otto committed
249

250
For more structured form layouts, you can utilize Bootstrap's predefined grid classes (or mixins). Add the `.row` class to form groups and use the `.col-*` classes to specify the width of your labels and controls. To vertically center the labels with the textual inputs—nearly anything with `.form-control`—use the `.form-control-label` class.
Mark Otto's avatar
Mark Otto committed
251
252

{% example html %}
253
254
<form>
  <div class="form-group row">
255
    <label for="inputEmail3" class="col-sm-2 form-control-label">Email</label>
Mark Otto's avatar
Mark Otto committed
256
257
258
259
    <div class="col-sm-10">
      <input type="email" class="form-control" id="inputEmail3" placeholder="Email">
    </div>
  </div>
260
  <div class="form-group row">
261
    <label for="inputPassword3" class="col-sm-2 form-control-label">Password</label>
Mark Otto's avatar
Mark Otto committed
262
263
264
265
    <div class="col-sm-10">
      <input type="password" class="form-control" id="inputPassword3" placeholder="Password">
    </div>
  </div>
266
  <div class="form-group row">
267
    <label class="col-sm-2">Radios</label>
268
269
270
    <div class="col-sm-10">
      <div class="radio">
        <label>
271
          <input type="radio" name="gridRadios" id="gridRadios1" value="option1" checked>
272
273
274
275
276
          Option one is this and that&mdash;be sure to include why it's great
        </label>
      </div>
      <div class="radio">
        <label>
277
          <input type="radio" name="gridRadios" id="gridRadios2" value="option2">
278
279
280
281
282
          Option two can be something else and selecting it will deselect option one
        </label>
      </div>
      <div class="radio disabled">
        <label>
283
          <input type="radio" name="gridRadios" id="gridRadios3" value="option3" disabled>
284
285
286
287
288
289
          Option three is disabled
        </label>
      </div>
    </div>
  </div>
  <div class="form-group row">
290
    <label class="col-sm-2">Checkbox</label>
291
    <div class="col-sm-10">
Mark Otto's avatar
Mark Otto committed
292
293
      <div class="checkbox">
        <label>
294
          <input type="checkbox"> Check me out
Mark Otto's avatar
Mark Otto committed
295
296
        </label>
      </div>
297
298
299
300
    </div>
  </div>
  <div class="form-group row">
    <div class="col-sm-offset-2 col-sm-10">
Mark Otto's avatar
Mark Otto committed
301
      <button type="submit" class="btn btn-secondary">Sign in</button>
Mark Otto's avatar
Mark Otto committed
302
303
304
    </div>
  </div>
</form>
Mark Otto's avatar
Mark Otto committed
305
{% endexample %}
Mark Otto's avatar
Mark Otto committed
306

307
## Checkboxes and radios
Mark Otto's avatar
Mark Otto committed
308
309
310

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
311
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
312

313
### Default (stacked)
Mark Otto's avatar
Mark Otto committed
314
315

{% example html %}
Mark Otto's avatar
Mark Otto committed
316
317
318
319
320
321
<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
322
323
324
325
326
327
<div class="checkbox disabled">
  <label>
    <input type="checkbox" value="" disabled>
    Option two is disabled
  </label>
</div>
Mark Otto's avatar
Mark Otto committed
328
329
330

<div class="radio">
  <label>
331
    <input type="radio" name="exampleRadios" id="exampleRadios1" value="option1" checked>
Mark Otto's avatar
Mark Otto committed
332
333
334
335
336
    Option one is this and that&mdash;be sure to include why it's great
  </label>
</div>
<div class="radio">
  <label>
337
    <input type="radio" name="exampleRadios" id="exampleRadios2" value="option2">
Mark Otto's avatar
Mark Otto committed
338
339
340
    Option two can be something else and selecting it will deselect option one
  </label>
</div>
Chris Rebert's avatar
Chris Rebert committed
341
342
<div class="radio disabled">
  <label>
343
    <input type="radio" name="exampleRadios" id="exampleRadios3" value="option3" disabled>
Chris Rebert's avatar
Chris Rebert committed
344
345
346
    Option three is disabled
  </label>
</div>
Mark Otto's avatar
Mark Otto committed
347
{% endexample %}
Mark Otto's avatar
Mark Otto committed
348

349
### Inline
Mark Otto's avatar
Mark Otto committed
350
351
352
353

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
354
355
356
357
358
359
360
361
362
<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>
363
{% endexample %}
Mark Otto's avatar
Mark Otto committed
364

365
{% example html %}
Mark Otto's avatar
Mark Otto committed
366
367
368
369
370
371
372
373
374
<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
375
{% endexample %}
Mark Otto's avatar
Mark Otto committed
376

377
### Without labels
Mark Otto's avatar
Mark Otto committed
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393

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

{% example html %}
<div class="checkbox">
  <label>
    <input type="checkbox" id="blankCheckbox" value="option1">
  </label>
</div>
<div class="radio">
  <label>
    <input type="radio" name="blankRadio" id="blankRadio1" value="option1">
  </label>
</div>
{% endexample %}

Mark Otto's avatar
Mark Otto committed
394
## Static controls
Mark Otto's avatar
Mark Otto committed
395

Mark Otto's avatar
Mark Otto committed
396
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
397
398

{% example html %}
Mark Otto's avatar
Mark Otto committed
399
<form class="form-horizontal">
Mark Otto's avatar
Mark Otto committed
400
401
402
403
404
405
406
407
408
409
410
411
412
  <div class="form-group">
    <label class="col-sm-2 control-label">Email</label>
    <div class="col-sm-10">
      <p class="form-control-static">email@example.com</p>
    </div>
  </div>
  <div class="form-group">
    <label for="inputPassword" class="col-sm-2 control-label">Password</label>
    <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
413
{% endexample %}
Mark Otto's avatar
Mark Otto committed
414

Mark Otto's avatar
Mark Otto committed
415
{% example html %}
Mark Otto's avatar
Mark Otto committed
416
<form class="form-inline">
Mark Otto's avatar
Mark Otto committed
417
418
419
420
421
422
423
424
  <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
425
  <button type="submit" class="btn btn-primary">Confirm identity</button>
Mark Otto's avatar
Mark Otto committed
426
427
428
</form>
{% endexample %}

Mark Otto's avatar
Mark Otto committed
429
## Disabled states
Mark Otto's avatar
Mark Otto committed
430

Mark Otto's avatar
Mark Otto committed
431
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
432
433

{% highlight html %}
Mark Otto's avatar
Mark Otto committed
434
435
436
437
438
439
<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
440
<form>
Mark Otto's avatar
Mark Otto committed
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
  <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
460
{% endexample %}
Mark Otto's avatar
Mark Otto committed
461

462
463
{% callout warning %}
#### Caveat about link functionality of `<a>`
Mark Otto's avatar
Mark Otto committed
464

465
466
467
468
469
470
471
472
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) (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.
{% 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
473
474
475

## Readonly inputs

Mark Otto's avatar
Mark Otto committed
476
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
477
478

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

Mark Otto's avatar
Mark Otto committed
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
## Control sizing

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

{% example html %}
<input class="form-control form-control-lg" type="text" placeholder=".input-lg">
<input class="form-control" type="text" placeholder="Default input">
<input class="form-control form-control-sm" type="text" placeholder=".input-sm">
{% 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
518
519
520
No official help text classes exist in Bootstrap 4 (previously we had `.help-block` in v3), but thanks to our utility classes like `.text-muted`, you can create much more flexible help text as you need it.

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

{% example html %}
Mark Otto's avatar
Mark Otto committed
523
524
525
<small class="text-muted">
  Some inline text with a small tag looks like this.
</small>
526
527
{% endexample %}

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

530
531
532
533
{% example html %}
<p class="text-muted">
  A block of help text that breaks onto a new line and may extend beyond one line.
</p>
Mark Otto's avatar
Mark Otto committed
534
535
{% endexample %}

Mark Otto's avatar
Mark Otto committed
536
## Validation
Mark Otto's avatar
Mark Otto committed
537

Mark Otto's avatar
Mark Otto committed
538
Bootstrap includes validation styles for error, warning, and success states on form controls. To use, add `.has-warning`, `.has-error`, or `.has-success` to the parent element. Any `.control-label`, `.form-control`, and `.text-help` within that element will receive the validation styles.
Mark Otto's avatar
Mark Otto committed
539

540
{% comment %}
541
542
543
544
545
546
547
{% 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 %}
548
{% endcomment %}
Mark Otto's avatar
Mark Otto committed
549

Mark Otto's avatar
Mark Otto committed
550
{% example html %}
Mark Otto's avatar
Mark Otto committed
551
552
<div class="form-group has-success">
  <label class="control-label" for="inputSuccess1">Input with success</label>
553
  <input type="text" class="form-control form-control-success" id="inputSuccess1">
Mark Otto's avatar
Mark Otto committed
554
555
556
</div>
<div class="form-group has-warning">
  <label class="control-label" for="inputWarning1">Input with warning</label>
557
  <input type="text" class="form-control form-control-warning" id="inputWarning1">
Mark Otto's avatar
Mark Otto committed
558
559
560
</div>
<div class="form-group has-error">
  <label class="control-label" for="inputError1">Input with error</label>
561
  <input type="text" class="form-control form-control-error" id="inputError1">
Mark Otto's avatar
Mark Otto committed
562
</div>
563

Mark Otto's avatar
Mark Otto committed
564
565
566
<div class="has-success">
  <div class="checkbox">
    <label>
Mark Otto's avatar
Mark Otto committed
567
      <input type="checkbox" id="checkboxSuccess" value="option1">
Mark Otto's avatar
Mark Otto committed
568
      Checkbox with success
569
570
571
    </label>
  </div>
</div>
Mark Otto's avatar
Mark Otto committed
572
573
<div class="has-warning">
  <div class="checkbox">
574
    <label>
Mark Otto's avatar
Mark Otto committed
575
      <input type="checkbox" id="checkboxWarning" value="option1">
Mark Otto's avatar
Mark Otto committed
576
      Checkbox with warning
577
578
    </label>
  </div>
Mark Otto's avatar
Mark Otto committed
579
580
581
</div>
<div class="has-error">
  <div class="checkbox">
582
    <label>
Mark Otto's avatar
Mark Otto committed
583
584
      <input type="checkbox" id="checkboxError" value="option1">
      Checkbox with error
585
586
587
    </label>
  </div>
</div>
Mark Otto's avatar
Mark Otto committed
588
{% endexample %}
Mark Otto's avatar
Mark Otto committed
589

590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
## Custom forms

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 any default form control.

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

We hide the default `<input>` with `opacity` and use the `.c-indicator` to build a new custom form control. We can't build a custom one from just the `<input>` because CSS's `content` doesn't work on that element.

With the sibling selector (`~`), we use the `:checked` state to trigger a makeshift checked state on the custom control.

In the checked states, we use **base64 embedded SVG icons** from [Open Iconic](http://useiconic.com/open). This provides us the best control for styling and positioning across browsers and devices.

#### Checkboxes

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

618
Custom checkboxes can also utilize the `:indeterminate` pseudo class when manually set via JavaScript (there is no available HTML attribute for specifying it).
619
620
621
622
623
624
625
626
627

<div class="bd-example bd-example-indeterminate">
  <label class="c-input c-checkbox">
    <input type="checkbox">
    <span class="c-indicator"></span>
    Check this custom checkbox
  </label>
</div>

628
 If you're using jQuery, something like this should suffice:
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669

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

#### Radios

{% example html %}
<label class="c-input c-radio">
  <input id="radio1" name="radio" type="radio">
  <span class="c-indicator"></span>
  Toggle this custom radio
</label>
<label class="c-input c-radio">
  <input id="radio2" name="radio" type="radio">
  <span class="c-indicator"></span>
  Or toggle this other custom radio
</label>
{% endexample %}

#### Stacked

Custom checkboxes and radios are inline to start. Add a parent with class `.c-inputs-stacked` to ensure each form control is on separate lines.

{% example html %}
<div class="c-inputs-stacked">
  <label class="c-input c-radio">
    <input id="radioStacked1" name="radio-stacked" type="radio">
    <span class="c-indicator"></span>
    Toggle this custom radio
  </label>
  <label class="c-input c-radio">
    <input id="radioStacked2" name="radio-stacked" type="radio">
    <span class="c-indicator"></span>
    Or toggle this other custom radio
  </label>
</div>
{% endexample %}

### Select menu

670
Custom `<select>` menus need only a custom class, `.c-selecct` to trigger the custom styles.
671
672

{% example html %}
673
674
675
676
677
678
<select class="c-select">
  <option selected>Open this select menu</option>
  <option value="1">One</option>
  <option value="2">Two</option>
  <option value="3">Three</option>
</select>
679
680
{% endexample %}

681
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.**
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702

### File browser

{% example html %}
<label class="file">
  <input type="file" id="file">
  <span class="file-custom"></span>
</label>
{% endexample %}

The file input is the most gnarly of the bunch. Here's how it works:

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

**Heads up!** The custom file input is currently unable to update the *Choose file...* text with the filename. Without JavaScript, this might not be possible to change, but I'm open to ideas.