Checkbox group
Features
- Provides standard spacing between checkboxes
- Compatible with our Form control component
- Adheres to our form accessibility guidelines.
When to use
Use a checkbox group to allow users to select multiple options from a small, predefined set of choices. For larger sets of options, consider using a Select component instead.
Examples
Label
The label of a form element should be clear and concise, ideally under three words. It should describe the value of the element and not what the user needs to do in order to fill it out properly.
Required or optional
Mark the minority of form elements in a form as required or optional. This helps users scan the form and understand what is required of them. Type out the word optional or required in the label. E.g. "Per purchase limit (optional)". Don't use asterisks or other symbols.
Hint text
Use hint text to give users clear guidance for data entry. Keep it brief and avoid repeating the label or other form details. If it feels redundant, try removing it. We keep help text above the input field to have the reading order match the visual order, which is needed for screen readers.
Help popover
Use help popovers to aid first-time users or to clarify complex concepts. The help popover can contain interactive content and may be used to provide links for further information.
Error
Provide clear and helpful error messages that guide users toward a solution. Instead of merely stating the problem, ensure the message is specific and actionable. Avoid vague or shaming language.
Individual checkboxes should not have its own error message or style.
Skeleton
Use a "skeleton" version of this component to display a loading state while data is being fetched. It provides a visual placeholder, giving users a preview of the UI structure before the actual content is loaded. This enhances the user experience by offering a more accurate representation of the final layout during data retrieval.
Disabled
Disable a form element to indicate that it’s currently unavailable. This can be used to maintain layout consistency and communicate that the element may become available later. If the form element will never be available in a given context, leave it out.
Best practices
Refer to our Forms guidelines for general advice on forms structure, validation, and more.
Related components
- Checkbox: A form element that enables users to make a binary choice (checked/unchecked).
- Form control: Form control displays a labelled input and, optionally, associated validation text, help popover, and/or hint text.
- Radio group: A form element that enables users to select a single value from a list of options.
- Select: A form element that enables users to select a single or multiple values from a list of options.