twbs--bootstrap/docs/content/forms.md

22 KiB

layout title
page Forms

Bootstrap normalizes common HTML5 form elements and adds a number of layout options for building forms of all sizes.

Example form

Individual form controls automatically receive some global styling. All textual <input>, <textarea>, and <select> elements with .form-control are set to width: 100%; by default. Wrap labels and controls in .form-group for optimum spacing.

{% example html %}

Example block-level help text here.

Submit {% endexample %}

Don't mix form groups with input groups

Do not mix form groups directly with input groups. Instead, nest the input group inside of the form group.

Inline forms

Add .form-inline to your <form> or a parent element for left-aligned and inline-block controls. This only applies to form controls within viewports that are at least 768px wide.

May require custom widths

Inputs and selects have `width: 100%;` applied by default in Bootstrap. Within inline forms, we reset that to `width: auto;` so multiple controls can reside on the same line. Depending on your layout, additional custom widths may be required.

Always add labels

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.

Visible labels

{% example html %}

Send invitation
{% endexample %}

Hidden labels

{% example html %}

Sign in {% endexample %}

{% example html %}

$
.00
Transfer cash {% endexample %}

Horizontal forms

Use Bootstrap's predefined grid classes to align labels and groups of form controls in a horizontal layout by adding .form-horizontal to the form or form control's parent. Doing so changes .form-groups to behave as grid rows, so no need for .row.

{% example html %}

Sign in
{% endexample %}

Supported controls

Examples of standard form controls supported in an example form layout.

Inputs

Most common form control, text-based input fields. Includes support for all HTML5 types: text, password, datetime, datetime-local, date, month, time, week, number, email, url, search, tel, and color.

Type declaration required

Inputs will only be fully styled if their `type` is properly declared.

{% example html %} {% endexample %}

Input groups

To add integrated text or buttons before and/or after any text-based `<input>`, check out the input group component.

Textarea

Form control which supports multiple lines of text. Change rows attribute as necessary.

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

A checkbox or radio with the disabled attribute will be styled appropriately. To have the <label> for the checkbox or radio also display a "not-allowed" cursor when the user hovers over the label, add the .disabled class to your .radio, .radio-inline, .checkbox, .checkbox-inline, or <fieldset>.

Default (stacked)

{% example html %}

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

{% example html %} {% endexample %}

Without labels

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

{% endexample %}

Selects

Note that many native select menus—namely in Safari and Chrome—have rounded corners that cannot be modified via border-radius properties.

Use the default option, or add multiple to show multiple options at once.

{% example html %} 1 2 3 4 5 {% endexample %}

For <select> controls with the multiple attribute, multiple options are shown by default.

{% example html %} 1 2 3 4 5 {% 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 <p>.

{% example html %}

{% endexample %}

{% example html %}

Confirm identity {% endexample %}

Focus state

We remove the default outline styles on some form controls and apply a box-shadow in its place for :focus.

Demo `:focus` state

The above example input uses custom styles in our documentation to demonstrate the `:focus` state on a `.form-control`.

Disabled states

Add the disabled boolean attribute on an <input>, <select>, or <textarea> to prevent user input and trigger a slightly different look.

{% highlight html %} {% endhighlight %}

Add the disabled attribute to a <fieldset> to disable all the controls within.

{% example html %}

Disabled select
Submit {% endexample %}

Caveat about link functionality of `<a>`

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

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.

Readonly inputs

Add the readonly boolean attribute on an input to prevent user input and style the input as disabled.

{% example html %} {% endexample %}

Validation

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 .help-block within that element will receive the validation styles.

{% example html %}

{% endexample %}

You can also add optional feedback icons with the addition of .has-feedback and the right icon.

Icons, labels, and input groups

Manual positioning of feedback icons is required for inputs without a label and for input groups with an add-on on the right. You are strongly encouraged to provide labels for all inputs for accessibility reasons. If you wish to prevent labels from being displayed, hide them with the `sr-only` class. If you must do without labels, adjust the `top` value of the feedback icon. For input groups, adjust the `right` value to an appropriate pixel value depending on the width of your addon.

{% example html %}

(success)
(warning)
(error)
@
(success)
{% endexample %}

{% example html %}


@
(success)
{% endexample %}

{% example html %}

{% endexample %}

{% example html %}

@
(success)
{% endexample %}

For form controls with no visible label, add the .sr-only class on the label. Bootstrap will automatically adjust the position of the icon once it's been added.

{% example html %}

{% endexample %}

Control sizing

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

{% example html %}

{% endexample %}

Quickly size labels and form controls within .form-horizontal by adding .form-group-lg or .form-group-sm to existing .form-groups.

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

Block level help text for form controls.

{% example html %}

A block of help text that breaks onto a new line and may extend beyond one line.

{% endexample %}