Components
Radio
Allows users to select a single option from a list. Use RadioGroup to manage a set of related radio buttons with a shared label and validation state.
Replacing soon
GitHubWith an optional description
Anatomy
Anatomy
import {Radio, RadioGroup} from '@staffbase/design';
<Radio />
<RadioGroup />Examples
Radio group
Choose how you would like to be contacted.
API reference
Radio
| Name | Type | Description |
|---|---|---|
label | string | The label displayed next to the radio button. |
name | string | The HTML name attribute linking this radio to its group. |
value | string | The value submitted with the form or used to identify the selected option. |
checked | boolean | Controlled checked state. |
description | string | Descriptive text displayed below the label. |
disabled | boolean | Disables the radio option. |
onChange | (e: ChangeEvent<HTMLInputElement>) => void | Called when the radio is selected. |
hasError | boolean | Puts the radio into an error state. |
id | string | HTML id for the input element. Defaults to the `value` prop. |
className | string | CSS class applied to the container element. |
RadioGroup
| Name | Type | Description |
|---|---|---|
options | RadioProps[] | Array of radio options. Each entry accepts all `Radio` props. |
groupLabel | string | Label for the radio group. |
groupDescription | string | Descriptive text displayed below the group label. |
onChange | (e: ChangeEvent<HTMLInputElement>) => void | Change handler shared by all radios in the group. |
groupErrorMessage | string | Error message displayed when validation fails. |
disableAll | boolean | Disables all options in the group. |
requiredLabel | string | Text appended to the group label indicating the field is required, e.g. '(Required)'. |
errorAriaLive | offassertivepolite | Sets the priority with which screen readers announce the error message. |
className | string | CSS class applied to the group container. |