Choice list
A choice list lets you create a list of grouped radio buttons or checkboxes. Use this component if you need to group together a related list of interactive choices.
Props
No props found for this component, run `yarn gen:docs` to generate component meta first.
Slots
No slots found for this component, run `yarn gen:docs` to generate component meta first.
Events
ChoiceList events
Best practices
Choice lists should:
- Include a title that tells merchants what to do or explains the available options
- Label options clearly based on what the option will do
- Avoid mutually exclusive options when allowing multiple selection
Content guidelines
List titles
List titles should:
- Help merchants understand how the items in the list are grouped together, or should explain what kind of choice merchants are making
Be concise and scannable
- Use simple, clear language that can be read at a glance
- Keep list titles to a single sentence
- It the title introduces the list, it should end with a colon
- Should be written in sentence case
Not use colons
List choices
Every item in a choice list should:
- Start with a capital letter
- Not use commas or semicolons at the end of each line
- Be written in sentence case (the first word capitalized, the rest lowercase)
Helper text and descriptions
If your list contains helper text, only the description below the list item should contain punctuation.
Related components
- To present a long list of radio buttons or when space is constrained, use the select component
- To build a group of radio buttons or checkboxes with a custom layout, use the radio button component or checkbox component
- To display a simple, non-interactive list of related content, use the list component
Accessibility
The choice list component uses the accessibility features of the checkbox and radio button components.