Skip to content
Edit this page

Radio API

API reference docs for the React Radio 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 Radio from '@mui/material/Radio';
// or
import { Radio } from '@mui/material';
Learn about the difference by reading this guide on minimizing bundle size.

Props

Props of the ButtonBase component are also available.

checked

If true, the component is checked.

Type:

bool
checkedIcon

The icon to display when the component is checked.

Type:

node

Default:

<RadioButtonIcon checked />
classes

Override or extend the styles applied to the component.

Type:

object
color

The color of the component. It supports both default and custom theme colors, which can be added as shown in the palette customization guide.

Type:

'default' | 'primary' | 'secondary' | 'error' | 'info' | 'success' | 'warning' | string

Default:

'primary'
disabled

If true, the component is disabled.

Type:

bool
disableRipple

If true, the ripple effect is disabled.

Type:

bool

Default:

false
icon

The icon to display when the component is unchecked.

Type:

node

Default:

<RadioButtonIcon />
id

The id of the input element.

Type:

string
inputProps

Attributes applied to the input element.

Type:

object
inputRef

Pass a ref to the input element.

Type:

ref
name

Name attribute of the input element.

Type:

string
onChange

Callback fired when the state is changed.

Type:

func

Signature:

function(event: React.ChangeEvent) => void
  • event The event source of the callback. You can pull out the new value by accessing event.target.value (string). You can pull out the new checked state by accessing event.target.checked (boolean).
required

If true, the input element is required.

Type:

bool

Default:

false
size

The size of the component. small is equivalent to the dense radio styling.

Type:

'medium' | 'small' | string

Default:

'medium'
sx

The system prop that allows defining system overrides as well as additional CSS styles.

Type:

Array<func | object | bool> | func | object
value

The value of the component. The DOM API casts this to a string.

Type:

any
The ref is forwarded to the root element.

Inheritance

While not explicitly documented above, the props of the ButtonBase component are also available in Radio. You can take advantage of this to target nested components.

Theme default props

You can use MuiRadio to change the default props of this component with the theme.

CSS

The following class names are useful for styling with CSS (the state classes are marked).
To learn more, visit the component customization page.

.MuiRadio-rootroot

Styles applied to the root element.

.Mui-checkedcheckedSTATE

State class applied to the root element if checked={true}.

.Mui-disableddisabledSTATE

State class applied to the root element if disabled={true}.

.MuiRadio-colorPrimarycolorPrimary

Styles applied to the root element if color="primary".

.MuiRadio-colorSecondarycolorSecondary

Styles applied to the root element if color="secondary".

You can override the style of the component using one of these customization options: