DocsComponents

Checkbox

Checkboxs allow users to select multiple items from a list of individual items, or to mark one individual item as selected.
Contents

Bootstrap 5 Checkbox component

Checkbox component built with the latest Bootstrap 5. Checkboxe is used to select one or more options in a list of related items.

Checkbox also can be used to turn an option on or off. If you have a single option, avoid using a checkbox and use an on/off switch instead.

Basic examples

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.

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.

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

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.

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

Indeterminate

Checkboxes can utilize the :indeterminate pseudo class when manually set via JavaScript.

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

Javascript code

const inputs = document.getElementsByTagName("input");
for (let i = 0; i < inputs.length; i++) {
  inputs[i].indeterminate = true;
}

Checkbox toggle buttons

Create button-like checkboxes by using .btn styles rather than .form-check-label on the <label> elements.

These toggle buttons can further be grouped in a button group if needed. See an example of Checkbox button group.

<input type="checkbox" class="btn-check" id="btn-check" autocomplete="off" />
<label class="btn btn-default" for="btn-check">Mon</label>

<input type="checkbox" class="btn-check" id="btn-check2" checked autocomplete="off" />
<label class="btn btn-default" for="btn-check2">Tue</label>

<input type="checkbox" class="btn-check" id="btn-check3" autocomplete="off" />
<label class="btn btn-default" for="btn-check3">Wed</label>

<input type="checkbox" class="btn-check" id="btn-check4" autocomplete="off" />
<label class="btn btn-default" for="btn-check4">Thu</label>

<input type="checkbox" class="btn-check" id="btn-check5" autocomplete="off" disabled />
<label class="btn btn-default" for="btn-check5">Fri</label>
Visually, these checkbox toggle buttons are identical to the button plugin toggle buttons. 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.

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 section for details.

<input class="form-check-input" type="checkbox" id="checkboxNoLabe3" value="" aria-label="..." disabled />
<input class="form-check-input" type="checkbox" id="checkboxNoLabel" value="" aria-label="..." />
<input class="form-check-input" type="checkbox" id="checkboxNoLabe2" value="" aria-label="..." checked />

Inline

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

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

Reverse

Put your checkboxes on the opposite side with the .form-check-reverse modifier class.

<div class="form-check form-check-reverse">
  <input class="form-check-input" type="checkbox" value="" id="reverseCheck1" />
  <label class="form-check-label" for="reverseCheck1">
    Reverse checkbox
  </label>
</div>

<div class="form-check form-check-reverse">
  <input class="form-check-input" type="checkbox" value="" id="reverseCheck2" disabled />
  <label class="form-check-label" for="reverseCheck2">
    Disabled reverse checkbox
  </label>
</div>

Size

Checkboxes allows you to change the size in four different sizes: small, medium, large, and extra-large.

<div class="form-check">
  <input class="form-check-input form-check-input-sm" type="checkbox" value="" id="flexCheckSizeSmall" />
  <label class="form-check-label small" for="flexCheckSizeSmall">
    Small checkbox
  </label>
</div>

<div class="form-check">
  <input class="form-check-input" type="checkbox" value="" id="flexCheckSizeMedium" checked />
  <label class="form-check-label" for="flexCheckSizeMedium">
    Medium checkbox(Default)
  </label>
</div>

<div class="form-check">
  <input class="form-check-input form-check-input-lg" type="checkbox" value="" id="flexCheckSizeLarge" />
  <label class="form-check-label" for="flexCheckSizeLarge">
    Large checkbox
  </label>
</div>

<div class="form-check">
  <input class="form-check-input form-check-input-xl" type="checkbox" value="" id="flexCheckSizeExtraLarge" />
  <label class="form-check-label" for="flexCheckSizeExtraLarge">
    Extra large checkbox
  </label>
</div>

Accessibility

(WAI-ARIA: https://www.w3.org/WAI/ARIA/apg/patterns/checkbox/)

  • All form controls should have labels, and this includes radio buttons, checkboxes, and switches. In most cases, this is done by using the <label> HTML element.
  • When a label can’t be used, it’s necessary to add an attribute directly to the input component. In this case, you can apply the additional attribute (e.g. aria-label, aria-labelledby, title) on the element.