0
0
mirror of https://github.com/twbs/bootstrap.git synced 2024-12-04 16:24:22 +01:00
Bootstrap/site/content/docs/5.3/forms/checks-radios.md
Mark Otto 20ab8219a0
Sass docs updates (#37897)
* Add maps

* Redesign scss-docs rendering

* Update other CSS sections

* Fix linter
2023-01-16 18:57:24 -08:00

13 KiB

layout title description group aliases toc
docs Checks and radios Create consistent cross-browser and cross-device checkboxes and radios with our completely rewritten checks component. forms /docs/5.3/forms/checks/ true

Approach

Browser default checkboxes and radios are replaced with the help of .form-check, a series of classes for both input types that improves the layout and behavior of their HTML elements, that provide greater customization and cross browser consistency. Checkboxes are for selecting one or several options in a list, while radios are for selecting one option from many.

Structurally, our <input>s and <label>s are sibling elements as opposed to an <input> within a <label>. This is slightly more verbose as you must specify id and for attributes to relate the <input> and <label>. We use the sibling selector (~) for all our <input> states, like :checked or :disabled. When combined with the .form-check-label class, we can easily style the text for each item based on the <input>'s state.

Our checks use custom Bootstrap icons to indicate checked or indeterminate states.

Checks

{{< example >}}

{{< /example >}}

Indeterminate

Checkboxes can utilize the :indeterminate pseudo class when manually set via JavaScript (there is no available HTML attribute for specifying it).

{{< example class="bd-example-indeterminate" stackblitz_add_js="true" >}}

{{< /example >}}

Disabled

Add the disabled attribute and the associated <label>s are automatically styled to match with a lighter color to help indicate the input's state.

{{< example class="bd-example-indeterminate" stackblitz_add_js="true" >}}

{{< /example >}}

Radios

{{< example >}}

{{< /example >}}

Disabled

Add the disabled attribute and the associated <label>s are automatically styled to match with a lighter color to help indicate the input's state.

{{< example >}}

{{< /example >}}

Switches

A switch has the markup of a custom checkbox but uses the .form-switch class to render a toggle switch. Consider using role="switch" to more accurately convey the nature of the control to assistive technologies that support this role. In older assistive technologies, it will simply be announced as a regular checkbox as a fallback. Switches also support the disabled attribute.

{{< example >}}

{{< /example >}}

Default (stacked)

By default, any number of checkboxes and radios that are immediate sibling will be vertically stacked and appropriately spaced with .form-check.

{{< example >}}

{{< /example >}}

{{< example >}}

{{< /example >}}

Inline

Group checkboxes or radios on the same horizontal row by adding .form-check-inline to any .form-check.

{{< example >}}

{{< /example >}}

{{< example >}}

{{< /example >}}

Reverse

Put your checkboxes, radios, and switches on the opposite side with the .form-check-reverse modifier class.

{{< example >}}

{{< /example >}}

Without labels

Omit the wrapping .form-check for checkboxes and radios that have no label text. Remember to still provide some form of accessible name for assistive technologies (for instance, using aria-label). See the [forms overview accessibility]({{< docsref "/forms/overview#accessibility" >}}) section for details.

{{< example >}}

{{< /example >}}

Toggle buttons

Create button-like checkboxes and radio buttons by using .btn styles rather than .form-check-label on the <label> elements. These toggle buttons can further be grouped in a [button group]({{< docsref "/components/button-group" >}}) if needed.

Checkbox toggle buttons

{{< example >}} {{< /example >}}

{{< example >}} {{< /example >}}

{{< example >}} {{< /example >}}

{{< callout info >}} Visually, these checkbox toggle buttons are identical to the [button plugin toggle buttons]({{< docsref "/components/buttons#button-plugin" >}}). However, they are conveyed differently by assistive technologies: the checkbox toggles will be announced by screen readers as "checked"/"not checked" (since, despite their appearance, they are fundamentally still checkboxes), whereas the button plugin toggle buttons will be announced as "button"/"button pressed". The choice between these two approaches will depend on the type of toggle you are creating, and whether or not the toggle will make sense to users when announced as a checkbox or as an actual button. {{< /callout >}}

Radio toggle buttons

{{< example >}}

{{< /example >}}

Outlined styles

Different variants of .btn, such at the various outlined styles, are supported.

{{< example >}}


{{< /example >}}

CSS

Sass variables

Variables for checks:

{{< scss-docs name="form-check-variables" file="scss/_variables.scss" >}}

Variables for switches:

{{< scss-docs name="form-switch-variables" file="scss/_variables.scss" >}}