Skip to content
Edit this page

RadioGroup API

The API documentation of the RadioGroup React component. Learn more about the props and the CSS customization points.

Import

import RadioGroup from '@material-ui/core/RadioGroup';
// or
import { RadioGroup } from '@material-ui/core';

You can learn more about the difference by reading this guide.

Props

Name Type Default Description
children node The content of the component.
defaultValue Array<string>
| number
| string		 The default input element 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: object) => void
event: The event source of the callback. 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.

Any other props supplied will be provided to the root element (FormGroup).

Inheritance

The props of the FormGroup component are also available. You can take advantage of this behavior to target nested components.

Demos