RadioGroup API

API reference docs for the React RadioGroup component. Learn about the props, CSS, and other APIs of this exported module.

Component 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

className

Class name applied to the root element.

Type:string

color

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.

Type:'danger' | 'primary' | 'success' | 'warning' | string

Default:'neutral'

component

The component used for the root node. Either a string to use a HTML element or a component.

Type:elementType

defaultValue

The default value. Use when the component is not controlled.

Type:any

disableIcon

The radio's disabledIcon prop. If specified, the value is passed down to every radios under this element.

Type:bool

Default:false

name

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.

Type:string

onChange

Callback fired when a radio button is selected.

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).

orientation

The component orientation.

Type:'horizontal' | 'vertical'

Default:'vertical'

overlay

The radio's overlay prop. If specified, the value is passed down to every radios under this element.

Type:bool

Default:false

size

The size of the component.

To learn how to add custom sizes to the component, check out Themed components—Extend sizes.

Type:'sm' | 'md' | 'lg' | string

Default:'md'

slotProps

The props used for each slot inside.

Type:{ root?: func | object }

Default:{}

slots

The components used for each slot inside.

See Slots API below for more details.

Type:{ root?: elementType }

Default:{}

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

See the `sx` page for more details.

Type:Array<func | object | bool> | func | object

value

Value of the selected radio button. The DOM API casts this to a string.

Type:any

variant

The global variant to use.

To learn how to add your own variants, check out Themed components—Extend variants.

Type:'outlined' | 'plain' | 'soft' | 'solid' | string

Default:'plain'

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.

root

The component that renders the root.

Class name: .MuiRadioGroup-root

Default component: 'div'

CSS classes

These class names are useful for styling with CSS. They are applied to the component's slots when specific states are triggered.

.MuiRadioGroup-colorDanger

Class name applied to the root element if color="danger".

Rule name:colorDanger

.MuiRadioGroup-colorNeutral

Class name applied to the root element if color="neutral".

Rule name:colorNeutral

.MuiRadioGroup-colorPrimary

Class name applied to the root element if color="primary".

Rule name:colorPrimary

.MuiRadioGroup-colorSuccess

Class name applied to the root element if color="success".

Rule name:colorSuccess

.MuiRadioGroup-colorWarning

Class name applied to the root element if color="warning".

Rule name:colorWarning

.MuiRadioGroup-horizontal

Class name applied to the root element if orientation="horizontal".

Rule name:horizontal

.MuiRadioGroup-sizeLg

Class name applied to the root element if size="lg".

Rule name:sizeLg

.MuiRadioGroup-sizeMd

Class name applied to the root element if size="md".

Rule name:sizeMd

.MuiRadioGroup-sizeSm

Class name applied to the root element if size="sm".

Rule name:sizeSm

.MuiRadioGroup-variantOutlined

Class name applied to the root element if variant="outlined".

Rule name:variantOutlined

.MuiRadioGroup-variantPlain

Class name applied to the root element if variant="plain".

Rule name:variantPlain

.MuiRadioGroup-variantSoft

Class name applied to the root element if variant="soft".

Rule name:variantSoft

.MuiRadioGroup-variantSolid

Class name applied to the root element if variant="solid".

Rule name:variantSolid

.MuiRadioGroup-vertical

Class name applied to the root element if orientation="vertical".

Rule name: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.