Radio Group

The Radio Group allows the user to select one option from a set.

Use radio buttons when the user needs to see all available options.If available options can be collapsed, consider using aSelect component because it uses less space.

Radio buttons should have the most commonly used option selected by default.

Radio group

RadioGroup is a helpful wrapper used to groupRadio components that provides an easier API, and proper keyboard accessibility to the group.

Gender

FemaleMaleOther

<FormControl><FormLabelid="demo-radio-buttons-group-label">Gender</FormLabel><RadioGrouparia-labelledby="demo-radio-buttons-group-label"defaultValue="female"name="radio-buttons-group"><FormControlLabelvalue="female"control={<Radio/>}label="Female"/><FormControlLabelvalue="male"control={<Radio/>}label="Male"/><FormControlLabelvalue="other"control={<Radio/>}label="Other"/></RadioGroup></FormControl>

PressEnter to start editing

Direction

To lay out the buttons horizontally, set therow prop:

Gender

FemaleMaleOtherother

Controlled

You can control the radio with thevalue andonChange props:

Gender

FemaleMale

<FormControl><FormLabelid="demo-controlled-radio-buttons-group">Gender</FormLabel><RadioGrouparia-labelledby="demo-controlled-radio-buttons-group"name="controlled-radio-buttons-group"value={value}onChange={handleChange}><FormControlLabelvalue="female"control={<Radio/>}label="Female"/><FormControlLabelvalue="male"control={<Radio/>}label="Male"/></RadioGroup></FormControl>

PressEnter to start editing

Standalone radio buttons

Radio can also be used standalone, without the RadioGroup wrapper.

<Radiochecked={selectedValue==='a'}onChange={handleChange}value="a"name="radio-buttons"inputProps={{'aria-label':'A'}}/><Radiochecked={selectedValue==='b'}onChange={handleChange}value="b"name="radio-buttons"inputProps={{'aria-label':'B'}}/>

PressEnter to start editing

Size

Use thesize prop or customize the font size of the svg icons to change the size of the radios.

<Radio{...controlProps('a')}size="small"/><Radio{...controlProps('b')}/><Radio{...controlProps('c')}sx={{'& .MuiSvgIcon-root':{      fontSize:28,},}}/>

PressEnter to start editing

Color

<Radio{...controlProps('a')}/><Radio{...controlProps('b')}color="secondary"/><Radio{...controlProps('c')}color="success"/><Radio{...controlProps('d')}color="default"/><Radio{...controlProps('e')}sx={{    color: pink[800],'&.Mui-checked':{      color: pink[600],},}}/>

PressEnter to start editing

Label placement

You can change the placement of the label with theFormControlLabel component'slabelPlacement prop:

Label placement

BottomEnd

Show error

In general, radio buttons should have a value selected by default. If this is not the case, you can display an error if no value is selected when the form is submitted:

Customization

Here is an example of customizing the component.You can learn more about this in theoverrides documentation page.

Gender

FemaleMaleOther(Disabled option)

`useRadioGroup`

For advanced customization use cases, auseRadioGroup() hook is exposed.It returns the context value of the parent radio group.The Radio component uses this hook internally.

API

import{ useRadioGroup}from'@mui/material/RadioGroup';

Returns

value (object):

value.name (string [optional]): The name used to reference the value of the control.
value.onChange (func [optional]): Callback fired when a radio button is selected.
value.value (any [optional]): Value of the selected radio button.

Example

FirstSecond

<RadioGroupname="use-radio-group"defaultValue="first"><MyFormControlLabelvalue="first"label="First"control={<Radio/>}/><MyFormControlLabelvalue="second"label="Second"control={<Radio/>}/></RadioGroup>

PressEnter to start editing

When to use

Checkboxes vs. Radio Buttons

Accessibility

(WAI-ARIA:https://www.w3.org/WAI/ARIA/apg/patterns/radio/)

All form controls should have labels, and this includes radio buttons, checkboxes, and switches. In most cases, this is done by using the<label> element (FormControlLabel).
When a label can't be used, it's necessary to add an attribute directly to the input component.In this case, you can apply the additional attribute (for examplearia-label,aria-labelledby,title) via theinputProps property.

<Radiovalue="radioA"inputProps={{'aria-label':'Radio A',}}/>

API

See the documentation below for a complete reference to all of the props and classes available to the components mentioned here.

Movatterモバイル変換

Radio Group

Returns

Example