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.

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';
You can learn about the difference by reading this guide on minimizing bundle size.

Props

Props of the FormGroup component are also available.

NameTypeDefaultDescription
childrennode
The content of the component.
defaultValueany
The default value. Use when the component is not controlled.
namestring
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.
onChangefunc
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).
valueany
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.