diff options
Diffstat (limited to 'site/content/docs/5.0/forms/checks.md')
| -rw-r--r-- | site/content/docs/5.0/forms/checks.md | 211 |
1 files changed, 211 insertions, 0 deletions
diff --git a/site/content/docs/5.0/forms/checks.md b/site/content/docs/5.0/forms/checks.md new file mode 100644 index 0000000000..e189d1bb9b --- /dev/null +++ b/site/content/docs/5.0/forms/checks.md @@ -0,0 +1,211 @@ +--- +layout: docs +title: Checks +description: Create consistent cross-browser and cross-device checkboxes and radios with our completely rewritten checks component. +group: forms +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 label for assistive technologies (for instance, using `aria-label`). + +{{< 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 >}} |