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';
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).