RadioGroup API
API reference docs for the React RadioGroup component. Learn about the props, CSS, and other APIs of this exported module.
Demos
Import
import RadioGroup from '@mui/material/RadioGroup';
// or
import { RadioGroup } from '@mui/material';
Learn about the difference by reading this guide on minimizing bundle size.
Props of the FormGroup component are also available.
Name | Type | 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
|
value | any | Value of the selected radio button. The DOM API casts this to a string. |
ref
is forwarded to the root element.Inheritance
While not explicitly documented above, the props of the FormGroup component are also available in RadioGroup. You can take advantage of this to target nested components.
These class names are useful for styling with CSS. They are applied to the component's slots when specific states are triggered.
Class name | Rule name | Description |
---|---|---|
.Mui-error | State class applied to the root element if error={true} . | |
.MuiRadioGroup-root | root | Styles applied to the root element. |
.MuiRadioGroup-row | row | Styles applied to the root element if row={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.