Skip to content

Latest commit

 

History

History
495 lines (393 loc) · 20.4 KB

checks-radios.md

File metadata and controls

495 lines (393 loc) · 20.4 KB
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/forms/checks/
/docs/5.3/forms/checks/
/docs/forms/checks-radios/
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 Boosted icons to indicate checked or indeterminate states.

Checks

{{< example >}}

Default checkbox
Checked checkbox
{{< /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" >}}

Indeterminate checkbox
{{< /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" >}}

Disabled indeterminate checkbox
Disabled checkbox
Disabled checked checkbox
{{< /example >}}

Radios

{{< example >}}

Default radio
Default checked radio
{{< /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 >}}

Disabled radio
Disabled checked radio
{{< /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 >}}

Default switch checkbox input
Checked switch checkbox input
Disabled switch checkbox input
Disabled checked switch checkbox input
{{< /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 >}}

Default checkbox
Disabled checkbox
{{< /example >}}

{{< example >}}

Default radio
Second default radio
Disabled radio
{{< /example >}}

Inline

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

{{< example >}}

1
2
3 (disabled)
{{< /example >}}

{{< example >}}

1
2
3 (disabled)
{{< /example >}}

Reverse

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

{{< example >}}

Reverse checkbox
Disabled reverse checkbox
Reverse switch checkbox input
{{< /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

See Bootstrap examples that are incompatible with Orange Design System.
{{< design-callout-alert >}} These **checkbox toggle button** variants should not be used because they do not respect the Orange Design System specifications. Indeed, from the Orange Design System point of view a checkbox should always look like a checkbox component.

Instead, consider using our [Checks component]({{< docsref "/forms/checks-radios#checks" >}}), [Radios component]({{< docsref "/forms/checks-radios#radios" >}}) or [Radio toggle buttons component]({{< docsref "/forms/checks-radios#radio-toggle-buttons" >}}). {{< /design-callout-alert >}}

{{< example >}} Single toggle {{< /example >}}

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

{{< example >}} Disabled {{< /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

Boosted requires to group its radio toggle buttons in a [button group]({{< docsref "/components/button-group" >}}) to display properly.

{{< example >}}

Checked Radio Disabled Radio
{{< /example >}}

With icon

Add [.btn-icon]({{< docsref "/components/buttons" >}}#icon-only) with an [embedded icon]({{< docsref "/extend/icons" >}}) to get consistent squared icon buttons working as toggle.

{{< example >}}

Day Week Month
{{< /example >}}

Drop borders using .btn-no-outline, too.

{{< example >}}

Day Week Month
{{< /example >}}

Star rating

{{< added-in "5.2.0" >}}

Star rating system is built on top of radios. Simply add .star-rating to a <fieldset> element to use predefined glyphs and compose your star rating system with as much stars as needed.

{{< example >}}

Results relevance 
<input type="radio" id="terrible" name="rating" value="1" class="visually-hidden">
<label for="terrible" title="Terrible"><span class="visually-hidden">Terrible</span></label>

<input type="radio" id="bad" name="rating" value="2" class="visually-hidden">
<label for="bad" title="Bad"><span class="visually-hidden">Bad</span></label>

<input type="radio" id="mixed" name="rating" value="3" class="visually-hidden">
<label for="mixed" title="Mixed"><span class="visually-hidden">Mixed</span></label>

<input type="radio" id="good" name="rating" value="4" class="visually-hidden" checked>
<label for="good" title="Good"><span class="visually-hidden">Good</span></label>

<input type="radio" id="excellent" name="rating" value="5" class="visually-hidden">
<label for="excellent" title="Excellent"><span class="visually-hidden">Excellent</span></label>
{{< /example >}}

Sizes

Star ratings come with a smaller variant: .star-rating-sm.

{{< example >}}

Results relevance 
<input type="radio" id="terrible2" name="rating" value="1" class="visually-hidden">
<label for="terrible2" title="Terrible"><span class="visually-hidden">Terrible</span></label>

<input type="radio" id="bad2" name="rating" value="2" class="visually-hidden">
<label for="bad2" title="Bad"><span class="visually-hidden">Bad</span></label>

<input type="radio" id="mixed2" name="rating" value="3" class="visually-hidden">
<label for="mixed2" title="Mixed"><span class="visually-hidden">Mixed</span></label>

<input type="radio" id="good2" name="rating" value="4" class="visually-hidden" checked>
<label for="good2" title="Good"><span class="visually-hidden">Good</span></label>

<input type="radio" id="excellent2" name="rating" value="5" class="visually-hidden">
<label for="excellent2" title="Excellent"><span class="visually-hidden">Excellent</span></label>
{{< /example >}}

Dark variant

{{< deprecated-in "5.3.3" >}}

{{< callout-deprecated-dark-variants "star-rating" >}}

Readonly

Make star ratings readable but non-editable by using <span>s instead of <input> elements.

{{< example >}}

Star rating: rated 3 out of 5

{{< /example >}}

Disabled

Make star ratings look inactive inside or outside a form by adding the disabled boolean attribute to the <fieldset> element and the checked boolean attribute to any <input> element.

{{< example >}}

Disabled star rating 
<input type="radio" id="terrible4" name="rating" value="1" class="visually-hidden">
<label for="terrible4" title="Terrible"><span class="visually-hidden">Terrible</span></label>

<input type="radio" id="bad4" name="rating" value="2" class="visually-hidden">
<label for="bad4" title="Bad"><span class="visually-hidden">Bad</span></label>

<input type="radio" id="mixed4" name="rating" value="3" class="visually-hidden" checked>
<label for="mixed4" title="Mixed"><span class="visually-hidden">Mixed</span></label>

<input type="radio" id="good4" name="rating" value="4" class="visually-hidden">
<label for="good4" title="Good"><span class="visually-hidden">Good</span></label>

<input type="radio" id="excellent4" name="rating" value="5" class="visually-hidden">
<label for="excellent4" title="Excellent"><span class="visually-hidden">Excellent</span></label>

Disabled star rating: rated 3 out of 5

{{< /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" >}}

Sass mixins

{{< deprecated-in "5.3.2" >}}

{{< scss-docs name="form-star-rating-mixin" file="scss/mixins/_star-rating.scss" >}}