Components
Checkbox
Checkboxes allow users to select one or more options from a list.
About the checkbox component
Checkboxes are an easily understandable way to indicate that users can select one or more answers to a question or items from a list. They’re always followed by a label or instructions that clearly indicate what checking the box represents.
Each checkbox has two different states: selected or unselected, which are similar to an on and off switch. If a checkbox label says “Yes, send me an email,” it’s clear what checking that box (or not checking it) will accomplish.
Checkboxes also visibly show users what’s been selected and makes it easy for them to “uncheck” an option, which can be difficult with other selection methods on a form (such as radio buttons or select menus). It’s common to include “check all that apply” instructions with checkboxes to let users know it’s okay to select more than one option at a time.
Default
Tile
Guidance
When to use the checkbox component
- To display multiple answers. When a user can select any number of choices from a list.
- To allow users to toggle answers. When a user needs to acknowledge acceptance of something (like terms of service) or switch between two opposite states, such as unchecked = “no” and checked = “yes.”
When to consider something else
- Single-select only. If a user can only select one option from a list of many, use radio buttons instead.
Usability guidance
- Make the label selectable. Users should be able to select either the text label or the checkbox to select or deselect an option.
- List options vertically. Horizontal listings can make it difficult to tell which label pertains to which checkbox.
- Use positive statements. Negative language in labels can be counterintuitive. For example, use “I want to receive a promotional email” instead of “I don’t want to receive a promotional email.”
- Use logical labels. Make sure that the label makes both states — checked and unchecked — clear to the user. If that’s not possible, consider using a radio button with two individual options instead. Then both states can have their own clearly marked label.
- Use adequate touch targets. Make sure selections are adequately spaced for touch screens. Consider using the tile variant for larger touch targets.
- Don’t mix default and tile variants. Pick one implementation and stick with it. When mixed, tiles can appear to indicate a bias or preference toward that option.
- Use a logical order. Make sure the selection options are organized in a meaningful way, like alphabetical or most-frequent to least-frequent. This helps users easily find the option they’re looking for.
Accessibility
- Customize form controls accessibly. If you customize this component, ensure that it continues to meet the accessibility requirements that apply to all form controls.
- Use a fieldset and legend for a checkbox group. Surround a related set of checkboxes with a
<fieldset>
. The<legend>
provides context for the grouping. Don’t use fieldset and legend for a single check. - These custom checkboxes are accessible. The custom checkboxes here are accessible to screen readers because the default checkboxes are moved off-screen with
position: absolute; left: -999em
. - Use semantic tags. Each input should have a semantic tag for the
id
attribute, and its corresponding label should have the same value in itsfor
attribute.
Using the checkbox component
Checkbox settings
Variable | Description |
---|---|
$theme-checkbox-border-radius
|
Checkbox border radius for rounded corners. |
$theme-input-background-color
|
Background color for radio and checkbox inputs. |
$theme-input-tile-border-radius
|
Tile border radius for rounded corners. |
$theme-input-tile-border-width
|
Tile border thickness |
Checkbox variants
This component has no variants.
Package
-
Package usage:
@forward "usa-checkbox";
- Dependencies:
uswds-fonts
,usa-fieldset
,usa-legend
,usa-input-list
Latest updates
Meaningful code and guidance updates are listed in the following table:
Date | USWDS version | Affects | Description |
---|---|---|---|
2023-11-20 | N/A |
|
Added |
2023-09-29 | 3.6.1 |
|
Updated radio and checkbox tiles to have lighter borders, reducing visual noise. More information: uswds#5494 |
2023-06-09 | 3.5.0 |
|
Improved legibility in forced colors mode. Adds a consistent border in forced colors mode. More information: uswds#5147 |
2023-06-09 | 3.5.0 |
|
Improved consistency and visibility of disabled styles.
Form elements with the |
2023-06-09 | 3.5.0 |
|
Improved consistency of disabled styles in forced colors mode. More information: uswds#5295 |
2022-08-05 | 3.1.0 |
|
Styled aria-disabled to match disabled.
Now disabled styling is applied whether you use |
2022-04-28 | 3.0.0 |
|
Breaking Updated to Sass module syntax and new package structure. More information: uswds#4656 |
2022-04-11 | 2.13.3 |
|
Added support for forced colors mode. All our components now support proper display when users have a forced colors mode set in their operating system. More information: uswds#4610 |
2021-08-18 | 2.12.1 |
|
Improved whitespace sensitivity of radio and checkbox tiles. Now radio and checkbox tiles will display consistently whether or not there’s extra whitespace in the markup. More information: uswds#4286 |
2021-08-18 | 2.12.1 |
|
Improved class order sensitivity for checkbox and radio. Now checkbox and radio components display properly regardless of the order of the class and modifier names. More information: uswds#4262 |
2021-06-16 | 2.12.0 |
|
Updated checkbox and radio buttons to include automatic accessible color. Now checkbox and radio buttons will display in the proper accessible color, and adapt to the text, link, and background colors you set in your projects’s settings. More information: uswds#4199 |
2021-03-17 | 2.11.0 |
|
Fixed character display in checkboxes and radio buttons. Allowed checkboxes and radio buttons to display properly regardless of character encoding. More information: uswds#4080 |