Skip to main content

Checkbox

A Checkbox describes a state or value that can be either “On" or "Off.” Checkboxes are not mutually exclusive. More than one Checkbox may be checked at the same time.

Interactive Example

Rules of Thumb
  • Use Checkboxes when there is a list of options from which the user may select any number of choices.
  • In a list, each Checkbox is independent of all other Checkboxes.
  • When asking the user to make a mutually exclusive choice, use a Radio Button not a Checkbox.
  • Group Checkboxes whenever possible.
  • When grouped without a parent Checkbox, provide a group label.

Appearance and Behavior

A basic Checkbox consists of a visual indicator of its selected state followed by a label. Individual Checkboxes can appear selected (checked), Unselected (no check), and Disabled (no action can be taken by the user). An Indeterminate state (a dash symbol rather than checked) may display when a Checkbox is used as a parent of a group of Checkboxes where at least one child is selected and at least one is not.

A Checkbox can be configured for required input. Help Text for individual Checkbox list items left-aligns with the item’s text and not its icon for easier text scanning. To learn more about adding Help Text or Validation to Checkboxes or Checkbox groups, see the Forms and Validation guidance.

Don’t use a Checkbox to initiate an action. Instead, use an Action Button or a Switch Button

Examples
Do: Neatly arrange and group multiple Checkboxes whenever possible.
Do: Neatly arrange and group multiple Checkboxes whenever possible.
Don’t: Poorly placed and misaligned Checkboxes make it difficult for users to differentiate one state from another.
Don’t: Poorly placed and misaligned Checkboxes make it difficult for users to differentiate one state from another.
Do: Use parent Checkboxes, when grouped, to select all or select none.
Do: Use parent Checkboxes, when grouped, to select all or select none.
Don’t: Group a single Checkbox under a parent checkbox unless you have a good reason to do so.
Don’t: Group a single Checkbox under a parent checkbox unless you have a good reason to do so.
Do: Reflect an indeterminate state when a mix of child values are applied.
Do: Reflect an indeterminate state when a mix of child values are applied.
Don’t: Group Checkboxes without a parent label.
Don’t: Group Checkboxes without a parent label.

Asset Status
Asset Version Status
Documentation N/A Available
UI Kit - Dark v7 Available
UI Kit - Light v7 Available
UI Kit - Wireframe v7 Available
Web Component v7 Available
Component Tokens N/A Planned
Status Key
Available In Progress Planned Not Available Deprecated
Feedback

Help us improve Astro

Please rate your present experience with Astro:

Cancel

Request Access to Source Code Repository

The source code Git repository and other useful documentation for Astro’s apps are hosted on Github.com. Please fill out the form below to request access.

How Would You Like to Use Astro’s Source Code?
Which Astro App’s Source Code Would You Like Access to?
Successfully submitted request for source code