Radio API
API reference docs for the React Radio component. Learn about the props, CSS, and other APIs of this exported module.
Demos
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 of the ButtonBase component are also available.
Name | Type | Default | Description |
---|---|---|---|
checked | bool | - | If |
checkedIcon | node | <RadioButtonIcon checked /> | The icon to display when the component is checked. |
classes | object | - | Override or extend the styles applied to the component. See CSS classes API below for more details. |
color | 'default' | 'primary' | 'secondary' | 'error' | 'info' | 'success' | 'warning' | string | 'primary' | The color of the component. It supports both default and custom theme colors, which can be added as shown in the palette customization guide. |
disabled | bool | - | If |
disableRipple | bool | false | If |
icon | node | <RadioButtonIcon /> | The icon to display when the component is unchecked. |
id | string | - | The id of the |
inputProps | object | - | Attributes applied to the |
inputRef | ref | - | Pass a ref to the |
name | string | - | Name attribute of the |
onChange | func | - | Callback fired when the state is changed. Signature: function(event: React.ChangeEvent
|
required | bool | false | If |
size | 'medium' | 'small' | string | 'medium' | The size of the component. |
sx | Array<func | object | bool> | func | object | - | The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details. |
value | any | - | The value of the component. The DOM API casts this to a string. |
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.
These class names are useful for styling with CSS. They are applied to the component's slots when specific states are triggered.
Class name | Rule name | Description |
---|---|---|
.Mui-checked | State class applied to the root element if checked={true} . | |
.Mui-disabled | State class applied to the root element if disabled={true} . | |
.MuiRadio-colorPrimary | colorPrimary | Styles applied to the root element if color="primary" . |
.MuiRadio-colorSecondary | colorSecondary | Styles applied to the root element if color="secondary" . |
.MuiRadio-root | root | Styles applied to the root element. |
.MuiRadio-sizeSmall | sizeSmall | Styles applied to the root element if size="small" . |
You can override the style of the component using one of these customization options:
- With a global class name.
- With a rule name as part of the component's
styleOverrides
property in a custom theme.
Source code
If you did not find the information in this page, consider having a look at the implementation of the component for more detail.