RadioGroup API

API reference docs for the React RadioGroup component. Learn about the props, CSS, and other APIs of this exported module.

Demos

For examples and details on the usage of this React component, visit the component demo pages:

Radio Group

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

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: 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 in RadioGroup. You can take advantage of this to target nested components.

CSS classes

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.

Source code

If you did not find the information in this page, consider having a look at the implementation of the component for more detail.