RadioGroup API
Demos
For examples and details on the usage of this React component, visit the component demo pages:
Import
import RadioGroup from '@mui/material/RadioGroup';
// or
import { RadioGroup } from '@mui/material';
Component name
The nameMuiRadioGroup
can be used when providing default props or style overrides in the theme.Props
Props of the FormGroup component are also available.
Name | Type | Default | Description |
---|---|---|---|
children | node | The content of the component. | |
defaultValue | any | The default value. Use when the component is not controlled. | |
name | string | The name used to reference the value of the control. If you don't provide this prop, it falls back to a randomly generated name. | |
onChange | func | Callback fired when a radio button is selected. Signature: function(event: React.ChangeEvent<HTMLInputElement>, value: string) => void event: The event source of the callback. value: The value of the selected radio button. You can pull out the new value by accessing event.target.value (string). | |
value | any | Value of the selected radio button. The DOM API casts this to a string. |
The
ref
is forwarded to the root element.Inheritance
While not explicitly documented above, the props of the FormGroup component are also available on RadioGroup. You can take advantage of this to target nested components.CSS
Rule name | Global class | Description |
---|---|---|
root | .MuiRadioGroup-root | Styles applied to the root element. |
row | .MuiRadioGroup-row | Styles applied to the root element if row={true} . |
error | .Mui-error | State class applied to the root element if error={true} . |
You can override the style of the component using one of these customization options:
- With a global class name.
- With a rule name as part of the component's
styleOverrides
property in a custom theme.