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:

Radio

Import

import Radio from '@mui/joy/Radio';
// or
import { Radio } from '@mui/joy';

Learn about the difference by reading this guide on minimizing bundle size.

Props

Name	Type	Default	Description
checked	bool		If `true`, the component is checked.
checkedIcon	node		The icon to display when the component is checked.
className	string		Class name applied to the root element.
color	'danger' \| 'primary' \| 'success' \| 'warning' \| string	'neutral'	The color of the component. It supports those theme colors that make sense for this component. To learn how to add your own colors, check out Themed components—Extend colors.
component	elementType		The component used for the root node. Either a string to use a HTML element or a component.
defaultChecked	bool		The default checked state. Use when the component is not controlled.
disabled	bool		If `true`, the component is disabled.
disableIcon	bool	false	If `true`, the checked icon is removed and the selected variant is applied on the `action` element instead.
label	node		The label element at the end the radio.
name	string		The `name` attribute of the input.
onChange	func		Callback fired when the state is changed. 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).
overlay	bool	false	If `true`, the root element's position is set to initial which allows the action area to fill the nearest positioned parent. This prop is useful for composing Radio with ListItem component.
readOnly	bool		If `true`, the component is read only.
required	bool		If `true`, the `input` element is required.
size	'sm' \| 'md' \| 'lg' \| string	'md'	The size of the component. To learn how to add custom sizes to the component, check out Themed components—Extend sizes.
slotProps	{ action?: func \| object, icon?: func \| object, input?: func \| object, label?: func \| object, radio?: func \| object, root?: func \| object }	{}	The props used for each slot inside.
slots	{ action?: elementType, icon?: elementType, input?: elementType, label?: elementType, radio?: elementType, root?: elementType }	{}	The components used for each slot inside. See Slots API below for more details.
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.
uncheckedIcon	node		The icon to display when the component is not checked.
value	any		The value of the component. The DOM API casts this to a string.
variant	'outlined' \| 'plain' \| 'soft' \| 'solid' \| string	'outlined'	The global variant to use. To learn how to add your own variants, check out Themed components—Extend variants.

The ref is forwarded to the root element.

Theme default props

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

Slots

To learn how to customize the slot, check out the Overriding component structure guide.

Slot name	Class name	Default	Description
root	.MuiRadio-root	`'span'`	The component that renders the root.
radio	.MuiRadio-radio	`'span'`	The component that renders the radio.
icon	.MuiRadio-icon	`'span'`	The component that renders the icon.
action	.MuiRadio-action	`'span'`	The component that renders the action.
input	.MuiRadio-input	`'input'`	The component that renders the input.
label	.MuiRadio-label	`'label'`	The component that renders the label.

CSS classes

These class names are useful for styling with CSS. They are applied to the root slot when specific states are triggered.

Rule name	Description
.Mui-checked	State class applied to the root, action slots if `checked`.
.Mui-disabled	State class applied to the root, action slots if `disabled`.
.Mui-focusVisible	Class name applied to the root element if the switch has visible focus
.MuiRadio-colorContext	Class name applied to the root element when color inversion is triggered.
.MuiRadio-colorDanger	Class name applied to the root element if `color="danger"`.
.MuiRadio-colorNeutral	Class name applied to the root element if `color="neutral"`.
.MuiRadio-colorPrimary	Class name applied to the root element if `color="primary"`.
.MuiRadio-colorSuccess	Class name applied to the root element if `color="success"`.
.MuiRadio-colorWarning	Class name applied to the root element if `color="warning"`.
.MuiRadio-sizeLg	Class name applied to the root element if `size="lg"`.
.MuiRadio-sizeMd	Class name applied to the root element if `size="md"`.
.MuiRadio-sizeSm	Class name applied to the root element if `size="sm"`.
.MuiRadio-variantOutlined	Class name applied to the root element if `variant="outlined"`.
.MuiRadio-variantSoft	Class name applied to the root element if `variant="soft"`.
.MuiRadio-variantSolid	Class name applied to the root element if `variant="solid"`.

Have any feedback about this new API display design?

We've heard from you and iterated on making the design of API content documentation more scalable and easier to parse! We value your input, so please don't hesitate to share any additional feedback you may have.