--- layout: docs title: Forms group: components --- [//]: # DO NOT EDIT IT WILL BE OVERWRITTEN - copy of bootstrap documentation generated by grunt docs-copy-bootstrap-docs {% callout info %} **Bootstrap Reference Documentation** This is a part of the reference documentation from Bootstrap. It is included here to demonstrate rendering with Material Design for Bootstrap default styling. See the Material Design section for more elements and customization options. {% endcallout %} Bootstrap provides several form control styles, layout options, and custom components for creating a wide variety of forms. ## Contents * Will be replaced with the ToC, excluding the "Contents" header {:toc} ## Form controls 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. Remember, since Bootstrap utilizes the HTML5 doctype, **all inputs must have a `type` attribute**. {% example html %}

Email address We'll never share your email with anyone else.

Password

Example select

Example multiple select

Example textarea

File input This is some placeholder block-level help text for the above input. It's a bit lighter and easily wraps to a new line.

Radio buttons

Option one is this and that—be sure to include why it's great

Option two can be something else and selecting it will deselect option one

Option three is disabled

Check me out

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

Classes	Used for	Supported variations
{% markdown %}`.form-group`{% endmarkdown %}	Any group of form controls	{% markdown %}Use with any block-level element like ` ` or ` `{% endmarkdown %}
{% markdown %}`.form-control`{% endmarkdown %}	Textual inputs	{% markdown %}`text`, `password`, `datetime-local`, `date`, `month`, `time`, `week`, `number`, `email`, `url`, `search`, `tel`, `color`{% endmarkdown %}
	Select menus	{% markdown %}`multiple`, `size`{% endmarkdown %}
	Textareas	N/A
{% markdown %}`.form-control-file`{% endmarkdown %}	File inputs	{% markdown %}`file`{% endmarkdown %}
{% markdown %} `.radio` `.radio-inline` `.checkbox` `.checkbox-inline` {% endmarkdown %}	Checkboxes and radios	N/A

### Textual inputs Here are examples of `.form-control` applied to each textual HTML5 `` `type`. {% example html %}

Text

URL

Telephone

Password

Number

Date and time

Date

Month

Week

Time

Color

{% endexample %} ## 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. 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 `

`s, `

`s, or nearly any other element. {% example html %} {% endexample %} ### Inline forms 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: - 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. 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 `` with each form control. #### Visible labels {% example html %} {% endexample %} #### Hidden labels {% example html %} {% endexample %} {% example html %} {% endexample %} {% 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 %} ### Using the Grid For more structured form layouts, you can utilize Bootstrap's predefined grid classes (or 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. Be sure to add `.form-control-label` to your ``s as well so they're vertically centered with their associated form controls. For `` elements, you can use `.form-control-legend` to make them appear similar to regular `` elements. {% example html %} {% endexample %} ## Checkboxes and radios Checkboxes are for selecting one or several options in a list, while radios are for selecting one option from many. Disabled checkboxes and radios are supported, but to provide a "not-allowed" cursor on hover of the parent ``, you'll need to add the .disabled class to the parent `.radio`, `.radio-inline`, `.checkbox`, or `.checkbox-inline`. ### Default (stacked) {% example html %}

Option one is this and that—be sure to include why it's great

Option two is disabled

Option one is this and that—be sure to include why it's great

Option two can be something else and selecting it will deselect option one

Option three is disabled

{% endexample %} ### Inline 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 %} 1 2 3 {% endexample %} {% example html %} 1 2 3 {% endexample %} ### Without labels Should you have no text within the ``, 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`). {% example html %}

{% endexample %} ## Static controls When you need to place plain text next to a form label within a form, use the `.form-control-static` class on a `

`. {% example html %}

{% endexample %} {% example html %} {% endexample %} ## Disabled states Add the `disabled` boolean attribute on an input to prevent user interactions. Disabled inputs appear lighter and add a `not-allowed` cursor. {% highlight html %} {% endhighlight %} Add the `disabled` attribute to a `

` to disable all the controls within. {% example html %} {% endexample %} {% callout warning %} #### Caveat about link functionality of `` By default, browsers will treat all native form controls (``, ` {% endexample %} ## Control sizing Set heights using classes like `.form-control-lg`, and set widths using grid column classes like `.col-lg-*`. {% example html %} {% endexample %} {% example html %} {% endexample %} ## Column sizing Wrap inputs in grid columns, or any custom parent element, to easily enforce desired widths. {% example html %}

{% endexample %} ## Help text 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. {% 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 %} Inline text can use any typical inline HTML element (be it a ``, ``, or something else). {% example html %} {% endexample %} Block help text—for below inputs or for longer lines of help text—can be easily achieved with a `

`. {% example html %} Password

Your password must be 8-20 characters long, contain letters and numbers, and must not contain spaces, special characters or emoji.

{% endexample %} ## Validation Bootstrap includes validation styles for danger, warning, and success states on form controls. - To use, add `.has-warning`, `.has-danger`, or `.has-success` to the parent element. Any `.form-control-label`, `.form-control`, and `.text-help` within that element will receive the validation styles. - 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. - Icons can also be disabled entirely by setting the variables to `none` or commenting out the source Sass. {% comment %} {% 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 `` 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 %} {% endcomment %} {% example html %}

Input with success

Input with warning

Input with danger

Checkbox with success

Checkbox with warning

Checkbox with danger

{% endexample %} ## 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 for any default form control. ### Checkboxes and radios Each checkbox and radio is wrapped in a `` 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 ``s. - It triggers the state of the `` automatically, meaning no JavaScript is required. We hide the default `` 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 `` because CSS's `content` doesn't work on that element. We use the sibling selector (`~`) for all our `` 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 ``'s state. 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. #### Checkboxes {% example html %} Check this custom checkbox {% endexample %} Custom checkboxes can also utilize the `:indeterminate` pseudo class when manually set via JavaScript (there is no available HTML attribute for specifying it).

Check this custom checkbox

If you're using jQuery, something like this should suffice: {% highlight js %} $('.your-checkbox').prop('indeterminate', true) {% endhighlight %} #### Radios {% example html %} Toggle this custom radio Or toggle this other custom radio {% endexample %} #### Disabled Custom checkboxes and radios can also be disabled. Add the `disabled` boolean attribute to the `` and the custom indicator and label description will be automatically styled. {% example html %} Check this custom checkbox Toggle this custom radio {% endexample %} #### Validation states Add other states to your custom forms with our validation classes. {% example html %}

Check this custom checkbox

{% endexample %} #### Stacked 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. {% example html %}

Toggle this custom radio Or toggle this other custom radio

{% endexample %} ### Select menu Custom ` {% endexample %} Custom selects degrade nicely in IE9, receiving only a handful of overrides to remove the custom `background-image`. **Multiple selects (e.g., ` {% endexample %} Here's how it works: - We wrap the `` in a `` so the custom control properly triggers the file browser. - We hide the default file `` 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 `` for proper spacing for surrounding content. In other words, it's an entirely custom element, all generated via CSS. #### 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.