mirror of
https://github.com/twbs/bootstrap.git
synced 2024-12-02 14:24:19 +01:00
eeb73e0ccf
* Expand on disabled fieldsets and faked buttons include further advice/information on how to disable faked buttons for keyboard/AT users * Centralise accessible name advice in forms overview seems odd to only mention (separately) label, aria-label etc in input-group and layout. the advice is just as pertinent in other sections like select. checks only skims over this. moving this, in expanded form, into the overview section itself. adding a specific cross-reference (just because they are easily left with no accname at all) in the checks page. * Change warning about accessibility, modify server-side example - paradoxically, due to our current problems with validation (see #28414) and the fact that browsers seem to have improved in this area for the most part, it's now actually better to use browser-native validation - added explicit `id` and `aria-describedby` association to at least the server-side form error messages, to show how it should be done properly, and expanded the prose for that explaining this. * Replace `.sr-only` with `.visually-hidden` in new addition * Copy edits for clarity in parenthetical * Copy and formatting tweaks - Wordsmithing here and there - Turns some hyphens into em dashes - Turns a long running comma separated list into an unordered list - Rearranges some copy just a bit Co-authored-by: Mark Otto <markd.otto@gmail.com>
264 lines
11 KiB
Markdown
264 lines
11 KiB
Markdown
---
|
|
layout: docs
|
|
title: Checks and radios
|
|
description: Create consistent cross-browser and cross-device checkboxes and radios with our completely rewritten checks component.
|
|
group: forms
|
|
aliases: "/docs/5.0/forms/checks/"
|
|
toc: 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 >}}
|
|
<div class="form-check">
|
|
<input class="form-check-input" type="checkbox" value="" id="flexCheckDefault">
|
|
<label class="form-check-label" for="flexCheckDefault">
|
|
Default checkbox
|
|
</label>
|
|
</div>
|
|
<div class="form-check">
|
|
<input class="form-check-input" type="checkbox" value="" id="flexCheckChecked" checked>
|
|
<label class="form-check-label" for="flexCheckChecked">
|
|
Checked checkbox
|
|
</label>
|
|
</div>
|
|
{{< /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">}}
|
|
<div class="form-check">
|
|
<input class="form-check-input" type="checkbox" value="" id="flexCheckIndeterminate">
|
|
<label class="form-check-label" for="flexCheckIndeterminate">
|
|
Indeterminate checkbox
|
|
</label>
|
|
</div>
|
|
{{< /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 >}}
|
|
<div class="form-check">
|
|
<input class="form-check-input" type="checkbox" value="" id="flexCheckDisabled" disabled>
|
|
<label class="form-check-label" for="flexCheckDisabled">
|
|
Disabled checkbox
|
|
</label>
|
|
</div>
|
|
<div class="form-check">
|
|
<input class="form-check-input" type="checkbox" value="" id="flexCheckCheckedDisabled" checked disabled>
|
|
<label class="form-check-label" for="flexCheckCheckedDisabled">
|
|
Disabled checked checkbox
|
|
</label>
|
|
</div>
|
|
{{< /example >}}
|
|
|
|
## Radios
|
|
|
|
{{< example >}}
|
|
<div class="form-check">
|
|
<input class="form-check-input" type="radio" name="flexRadioDefault" id="flexRadioDefault1">
|
|
<label class="form-check-label" for="flexRadioDefault1">
|
|
Default radio
|
|
</label>
|
|
</div>
|
|
<div class="form-check">
|
|
<input class="form-check-input" type="radio" name="flexRadioDefault" id="flexRadioDefault2" checked>
|
|
<label class="form-check-label" for="flexRadioDefault2">
|
|
Default checked radio
|
|
</label>
|
|
</div>
|
|
{{< /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 >}}
|
|
<div class="form-check">
|
|
<input class="form-check-input" type="radio" name="flexRadioDisabled" id="flexRadioDisabled" disabled>
|
|
<label class="form-check-label" for="flexRadioDisabled">
|
|
Disabled radio
|
|
</label>
|
|
</div>
|
|
<div class="form-check">
|
|
<input class="form-check-input" type="radio" name="flexRadioDisabled" id="flexRadioCheckedDisabled" checked disabled>
|
|
<label class="form-check-label" for="flexRadioCheckedDisabled">
|
|
Disabled checked radio
|
|
</label>
|
|
</div>
|
|
{{< /example >}}
|
|
|
|
## Switches
|
|
|
|
A switch has the markup of a custom checkbox but uses the `.form-switch` class to render a toggle switch. Switches also support the `disabled` attribute.
|
|
|
|
{{< example >}}
|
|
<div class="form-check form-switch">
|
|
<input class="form-check-input" type="checkbox" id="flexSwitchCheckDefault">
|
|
<label class="form-check-label" for="flexSwitchCheckDefault">Default switch checkbox input</label>
|
|
</div>
|
|
<div class="form-check form-switch">
|
|
<input class="form-check-input" type="checkbox" id="flexSwitchCheckChecked" checked>
|
|
<label class="form-check-label" for="flexSwitchCheckChecked">Checked switch checkbox input</label>
|
|
</div>
|
|
<div class="form-check form-switch">
|
|
<input class="form-check-input" type="checkbox" id="flexSwitchCheckDisabled" disabled>
|
|
<label class="form-check-label" for="flexSwitchCheckDisabled">Disabled switch checkbox input</label>
|
|
</div>
|
|
<div class="form-check form-switch">
|
|
<input class="form-check-input" type="checkbox" id="flexSwitchCheckCheckedDisabled" checked disabled>
|
|
<label class="form-check-label" for="flexSwitchCheckCheckedDisabled">Disabled checked switch checkbox input</label>
|
|
</div>
|
|
{{< /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 >}}
|
|
<div class="form-check">
|
|
<input class="form-check-input" type="checkbox" value="" id="defaultCheck1">
|
|
<label class="form-check-label" for="defaultCheck1">
|
|
Default checkbox
|
|
</label>
|
|
</div>
|
|
<div class="form-check">
|
|
<input class="form-check-input" type="checkbox" value="" id="defaultCheck2" disabled>
|
|
<label class="form-check-label" for="defaultCheck2">
|
|
Disabled checkbox
|
|
</label>
|
|
</div>
|
|
{{< /example >}}
|
|
|
|
{{< example >}}
|
|
<div class="form-check">
|
|
<input class="form-check-input" type="radio" name="exampleRadios" id="exampleRadios1" value="option1" checked>
|
|
<label class="form-check-label" for="exampleRadios1">
|
|
Default radio
|
|
</label>
|
|
</div>
|
|
<div class="form-check">
|
|
<input class="form-check-input" type="radio" name="exampleRadios" id="exampleRadios2" value="option2">
|
|
<label class="form-check-label" for="exampleRadios2">
|
|
Second default radio
|
|
</label>
|
|
</div>
|
|
<div class="form-check">
|
|
<input class="form-check-input" type="radio" name="exampleRadios" id="exampleRadios3" value="option3" disabled>
|
|
<label class="form-check-label" for="exampleRadios3">
|
|
Disabled radio
|
|
</label>
|
|
</div>
|
|
{{< /example >}}
|
|
|
|
## Inline
|
|
|
|
Group checkboxes or radios on the same horizontal row by adding `.form-check-inline` to any `.form-check`.
|
|
|
|
{{< example >}}
|
|
<div class="form-check form-check-inline">
|
|
<input class="form-check-input" type="checkbox" id="inlineCheckbox1" value="option1">
|
|
<label class="form-check-label" for="inlineCheckbox1">1</label>
|
|
</div>
|
|
<div class="form-check form-check-inline">
|
|
<input class="form-check-input" type="checkbox" id="inlineCheckbox2" value="option2">
|
|
<label class="form-check-label" for="inlineCheckbox2">2</label>
|
|
</div>
|
|
<div class="form-check form-check-inline">
|
|
<input class="form-check-input" type="checkbox" id="inlineCheckbox3" value="option3" disabled>
|
|
<label class="form-check-label" for="inlineCheckbox3">3 (disabled)</label>
|
|
</div>
|
|
{{< /example >}}
|
|
|
|
{{< example >}}
|
|
<div class="form-check form-check-inline">
|
|
<input class="form-check-input" type="radio" name="inlineRadioOptions" id="inlineRadio1" value="option1">
|
|
<label class="form-check-label" for="inlineRadio1">1</label>
|
|
</div>
|
|
<div class="form-check form-check-inline">
|
|
<input class="form-check-input" type="radio" name="inlineRadioOptions" id="inlineRadio2" value="option2">
|
|
<label class="form-check-label" for="inlineRadio2">2</label>
|
|
</div>
|
|
<div class="form-check form-check-inline">
|
|
<input class="form-check-input" type="radio" name="inlineRadioOptions" id="inlineRadio3" value="option3" disabled>
|
|
<label class="form-check-label" for="inlineRadio3">3 (disabled)</label>
|
|
</div>
|
|
{{< /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 >}}
|
|
<div>
|
|
<input class="form-check-input" type="checkbox" id="checkboxNoLabel" value="" aria-label="...">
|
|
</div>
|
|
|
|
<div>
|
|
<input class="form-check-input" type="radio" name="radioNoLabel" id="radioNoLabel1" value="" aria-label="...">
|
|
</div>
|
|
{{< /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 >}}
|
|
<input type="checkbox" class="btn-check" id="btn-check" autocomplete="off">
|
|
<label class="btn btn-primary" for="btn-check">Single toggle</label>
|
|
{{< /example >}}
|
|
|
|
{{< example >}}
|
|
<input type="checkbox" class="btn-check" id="btn-check-2" checked autocomplete="off">
|
|
<label class="btn btn-primary" for="btn-check-2">Checked</label>
|
|
{{< /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 >}}
|
|
<input type="radio" class="btn-check" name="options" id="option1" autocomplete="off" checked>
|
|
<label class="btn btn-secondary" for="option1">Checked</label>
|
|
|
|
<input type="radio" class="btn-check" name="options" id="option2" autocomplete="off">
|
|
<label class="btn btn-secondary" for="option2">Radio</label>
|
|
|
|
<input type="radio" class="btn-check" name="options" id="option3" autocomplete="off">
|
|
<label class="btn btn-secondary" for="option3">Radio</label>
|
|
{{< /example >}}
|
|
|
|
### Outlined styles
|
|
|
|
Different variants of `.btn`, such at the various outlined styles, are supported.
|
|
|
|
{{< example >}}
|
|
<input type="checkbox" class="btn-check" id="btn-check-outlined" autocomplete="off">
|
|
<label class="btn btn-outline-primary" for="btn-check-outlined">Single toggle</label><br>
|
|
|
|
<input type="checkbox" class="btn-check" id="btn-check-2-outlined" checked autocomplete="off">
|
|
<label class="btn btn-outline-secondary" for="btn-check-2-outlined">Checked</label><br>
|
|
|
|
<input type="radio" class="btn-check" name="options-outlined" id="success-outlined" autocomplete="off" checked>
|
|
<label class="btn btn-outline-success" for="success-outlined">Checked success radio</label>
|
|
|
|
<input type="radio" class="btn-check" name="options-outlined" id="danger-outlined" autocomplete="off">
|
|
<label class="btn btn-outline-danger" for="danger-outlined">Danger radio</label>
|
|
{{< /example >}}
|