@hackoregon/component-library
Version:
Official repo for Hack Oregon React component library
31 lines (19 loc) • 1.19 kB
Markdown
# Radio Button Group Component
The CIVIC platform Radio Button Group component is built from Material UI's RadioGroup. It is customized to meet the needs of the CIVIC platform.
## Standard
The Standard story shows the standard usage of the Radio Button Group for the CIVIC platform. Radio Button Group includes standard styling.
These properties can be set in the Standard story:
- Group label - the label for the group of radio buttons. This is required to meet accessibility requirements.
- Labels - an array of labels, one for each radio button
- Disable the group of radio buttons
## Custom
The Custom story shows all possible properties that can be passed to the Radio Button Group component for customization in the CIVIC platform. They include the properties in the Standard Radio Button Group story, plus:
- Label placement
- Display all radio buttons in a row
## Example:
This example story shows the radio button group as it would be used in a form. In a form group, using additional Material UI components shown in the story, you can set values for:
- Group label
- Labels
- Display all radio buttons in a row
- Disable the group of radio buttons
- Form helper text