IconLogoMark
IconUiExpandCollapseDown

Release NotesIconUiExpandCollapseDown

ComponentsIconUiExpandCollapseDown

AvatarsIconUiExpandCollapseDown
ButtonsIconUiExpandCollapseDown
Data VisualizationIconUiExpandCollapseDown
DialogsIconUiExpandCollapseDown
IconsIconUiExpandCollapseDown
ModulesIconUiExpandCollapseDown
NotificationsIconUiExpandCollapseDown
ThemesIconUiExpandCollapseDown
TypeIconUiExpandCollapseDown

GuidelinesIconUiExpandCollapseDown

PatternsIconUiExpandCollapseDown

WordsIconUiExpandCollapseDown

ResourcesIconUiExpandCollapseDown

Checkbox

/

Design

Let users pick one or more options from a short list.

Checkboxes provide a natural and familiar way to indicate preference, allowing users to choose more than one option at a time. Use checkboxes with five or fewer options displayed simultaneously.

IconWarning
Version 5+
If using Uniform Version 5 or later, please refer to our Storybook docs for the Checkbox documentation and examples.

Size

A checkbox can be any of the four available sizes.

X-small: Only use this when you really need to squeeze, like in a sidebar.

A form’s density (standard, compact) is dictated by the form modifier component. Check those guidelines for more detailed recommendations.

State

A checkbox’s state depends on the interaction itself or a submission error.

The actual focus state is sorted for you, so anyone navigating via keyboard or screen reader is set. A disabled checkbox prevents the user from interacting with a field until certain conditions are met. It’s a good way to prevent invalid submissions, but should be used sparingly.

Mobile

Use Uniform checkboxes for both Apple and Android devices. Checkboxes should only be used within forms. If there are more than six options, display the options in a separate table view.

When selecting multiple items to perform an action, use a select mark in place of the checkbox.

Usage

Layout

Forms support multi-column layouts. Be cognizant of related fields and how they are typically represented. When in doubt, limit to one column.

Disabled States

An alternative to disabled states is conditionally displaying the field until it becomes relevant. It reduces cognitive load and creates a much clearer path to completing the form—especially as fields change with preceding selections.

Checkbox Buttons

The “button” or “button-minimal” display type can be used to show the checkbox options as a row or column of buttons. These should be used sparingly as a way for users to quickly select option(s) and only when all of the options are concise - no more than 15 characters.

Don't include long labels in the checkbox button options.

Don'tinclude long labels in the checkbox button options.

Do use checkbox buttons to toggle or filter data.

Douse checkbox buttons to toggle or filter data.

Microcopy

Labels

A label should clearly and concisely describe the field’s purpose with no more than a few words.

Don't make the label a complete sentence telling the user what to do.

Don'tmake the label a complete sentence telling the user what to do.

Do name exactly what belongs in that field.

Doname exactly what belongs in that field.

Check UI label guidelines for more detail on case and punctuation.

Help Text

In the case of an error, the help text should be updated explaining why an error occurred and how it’s fixed.

Don't allow errors without displaying help text.

Don'tallow errors without displaying help text.

Do use help text to explain why an error occurred and how it's fixed.

Douse help text to explain why an error occurred and how it's fixed.

Accessibility

Audit Results

See our full accessibility audit for more information about these results.

PlatformVisualInteractiveAutomatedDetails
ReactIconConfirmation PassIconConfirmation PassIconConfirmation Pass
React NativeIconConfirmation PassIconWarning WarningIconWarning N/A
  • IconWarningAt least one variation of this component does not meet the 44px touch target standard. (AAA)

Platform

platformnotes
Web
  • Stick to the guidelines above.
Apple
  • Stick to the guidelines above.
Android
  • Stick to the guidelines above.