Skip to content

RadioGroup API

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

Component 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

Props of the FormGroup component are also available.

children

The content of the component.

Type:node

defaultValue

The default value. Use when the component is not controlled.

Type:any

name

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.

Type:string

onChange

Callback fired when a radio button is selected.

Type:func

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

Value of the selected radio button. The DOM API casts this to a string.

Type:any

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.

.Mui-errorSTATE

State class applied to the root element if error={true}.

.MuiRadioGroup-root

Styles applied to the root element.

Rule name:root

.MuiRadioGroup-row

Styles applied to the root element if row={true}.

Rule name:row


You can override the style of the component using one of these customization options: