RadioGroup API

API reference docs for the React RadioGroup 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 RadioGroup from '@mui/joy/RadioGroup';
// or
import { RadioGroup } from '@mui/joy';

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

Props

Name	Type	Default	Description
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.
defaultValue	any	-	The default value. Use when the component is not controlled.
disableIcon	bool	false	The radio's `disabledIcon` prop. If specified, the value is passed down to every radios under this element.
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: React.ChangeEvent) => void` `event` The event source of the callback. You can pull out the new value by accessing `event.target.value` (string).
orientation	'horizontal' \| 'vertical'	'vertical'	The component orientation.
overlay	bool	false	The radio's `overlay` prop. If specified, the value is passed down to every radios under this element.
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	{ root?: func \| object }	{}	The props used for each slot inside.
slots	{ 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.
value	any	-	Value of the selected radio button. The DOM API casts this to a string.
variant	'outlined' \| 'plain' \| 'soft' \| 'solid' \| string	'plain'	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 JoyRadioGroup 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 component	Description
root	.MuiRadioGroup-root	`'div'`	The component that renders the root.

CSS classes

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
.MuiRadioGroup-colorDanger	colorDanger	Class name applied to the root element if `color="danger"`.
.MuiRadioGroup-colorNeutral	colorNeutral	Class name applied to the root element if `color="neutral"`.
.MuiRadioGroup-colorPrimary	colorPrimary	Class name applied to the root element if `color="primary"`.
.MuiRadioGroup-colorSuccess	colorSuccess	Class name applied to the root element if `color="success"`.
.MuiRadioGroup-colorWarning	colorWarning	Class name applied to the root element if `color="warning"`.
.MuiRadioGroup-horizontal	horizontal	Class name applied to the root element if `orientation="horizontal"`.
.MuiRadioGroup-sizeLg	sizeLg	Class name applied to the root element if `size="lg"`.
.MuiRadioGroup-sizeMd	sizeMd	Class name applied to the root element if `size="md"`.
.MuiRadioGroup-sizeSm	sizeSm	Class name applied to the root element if `size="sm"`.
.MuiRadioGroup-variantOutlined	variantOutlined	Class name applied to the root element if `variant="outlined"`.
.MuiRadioGroup-variantPlain	variantPlain	Class name applied to the root element if `variant="plain"`.
.MuiRadioGroup-variantSoft	variantSoft	Class name applied to the root element if `variant="soft"`.
.MuiRadioGroup-variantSolid	variantSolid	Class name applied to the root element if `variant="solid"`.
.MuiRadioGroup-vertical	vertical	Class name applied to the root element if `orientation="vertical"`.

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.