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';

You can 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' \| 'info' \| '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<HTMLInputElement>) => 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.
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.