Skip to content

RadioGroup API

API documentation for the React RadioGroup component. Learn about the available props, and the CSS API.

Import

import RadioGroup from '@material-ui/core/RadioGroup';
// or
import { RadioGroup } from '@material-ui/core';
You can learn about the difference by reading this guide on minimizing bundle size.

Props

NameTypeDefaultDescription
childrennodeThe content of the component.
defaultValueArray<string>
| number
| string
The default input element value. Use when the component is not controlled.
namestringThe name used to reference the value of the control. If you don't provide this prop, it falls back to a randomly generated name.
onChangefuncCallback fired when a radio button is selected.

Signature:
function(event: object) => void
event: The event source of the callback. You can pull out the new value by accessing event.target.value (string).
valueanyValue of the selected radio button. The DOM API casts this to a string.

The ref is forwarded to the root element.
Any other props supplied will be provided to the root element (FormGroup).

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.

Demos