Radio Group
Choose one value from a mutually exclusive native RadioGroup.
This guide covers Material UI Core with the default Emotion engine; extensions and additional demos are explicitly classified.
Use case and business boundary
The host owns value and validation; associate the group label and keep a shared group name.
Native composition and scope
Radio, RadioGroup, FormControl, FormLabel, FormControlLabel
Preserve native Material UI composition and types; do not substitute JGuang UI/Base UI/Radix APIs. Example entries are not extra components.
Native installation and initialization
npm install @mui/material@9.4.0 @emotion/react@11.14.0 @emotion/styled@11.14.1
Use native npm and Emotion, not an invented JGuang UI Registry URL. Place examples inside native ThemeProvider; choose CssBaseline or ScopedCssBaseline for the project. Inspect React, existing providers, lockfile and SSR first. Never overwrite files or conceal peer conflicts. This batch verified React 19.2.8; React 18 and below require matching react-is. See the included bilingual setup guide.
Practical native parameters
These selected parameters are not a flattened universal API. Preserve the native declaring owner, slot structure, nullable values and generics.
| Owner.prop | Practical role | Declaration source |
|---|---|---|
RadioGroup.name | Native form/group name used for related controls. | RadioGroup |
RadioGroup.value | Controlled native value; its scalar/array/nullable type is owner-specific. | RadioGroup |
RadioGroup.onChange | Owning control's native callback; preserve its exact event/value/nullable signature. | RadioGroup |
Radio.checked | Controlled binary selection; pair with the native change callback. | Radio |
Radio.disabled | Native disabled interaction state; not an authorization check. | Radio |
Runnable native examples
Machine keys select example entries, not universal variant props. Native demo JSX/data stay unchanged; JGuang-authored acceptance fixtures are explicitly labelled.
- Radio group ·
RadioButtonsGroup· upstream native demo - Direction ·
RowRadioButtonsGroup· upstream native demo - Controlled ·
ControlledRadioButtonsGroup· upstream native demo - Standalone radio buttons ·
RadioButtons· upstream native demo - Size ·
SizeRadioButtons· upstream native demo - Color ·
ColorRadioButtons· upstream native demo - Label placement ·
FormControlLabelPlacement· upstream native demo - Show error ·
ErrorRadios· upstream native demo - Customization ·
CustomizedRadios· upstream native demo - Example ·
UseRadioGroup· upstream native demo
Actual usage example
Unmodified pinned native demo; copy its required local helper files together.
import * as React from 'react';
import Radio from '@mui/material/Radio';
import RadioGroup from '@mui/material/RadioGroup';
import FormControlLabel from '@mui/material/FormControlLabel';
import FormControl from '@mui/material/FormControl';
import FormLabel from '@mui/material/FormLabel';
export default function RadioButtonsGroup() {
const id = React.useId();
return (
<FormControl>
<FormLabel id={`${id}-label`}>Gender</FormLabel>
<RadioGroup
aria-labelledby={`${id}-label`}
defaultValue="female"
name="radio-buttons-group"
>
<FormControlLabel value="female" control={<Radio />} label="Female" />
<FormControlLabel value="male" control={<Radio />} label="Male" />
<FormControlLabel value="other" control={<Radio />} label="Other" />
</RadioGroup>
</FormControl>
);
}
Example dependency boundaries
react, @mui/material/Radio, @mui/material/RadioGroup, @mui/material/FormControlLabel, @mui/material/FormControl, @mui/material/FormLabel, @mui/material/colors, @mui/material/FormHelperText, @mui/material/Button, @mui/material/styles
Direct Icons/System/Utils example imports require their matching 9.4.0 packages. Relative data/helpers are part of the example closure, not extra components. Remote images and simulated operations do not supply a backend.
Pinned upstream API metadata reference
These tables retain the upstream metadata, not a newly inferred generic type system. Conditional generics, inherited props and callback details are defined by the source declarations below. Theme defaults may override metadata defaults.
Radio
import Radio from '@mui/material/Radio';
import { Radio } from '@mui/material';
Native inheritance: ButtonBase. Parent/DOM props are not fabricated as additional own props.
| Prop | Required | Upstream metadata type / constraint | Metadata default |
|---|---|---|---|
checked | no | bool | — |
checkedIcon | no | node | <RadioButtonIcon checked /> |
classes | no | object | — |
color | no | 'default' | 'primary' | 'secondary' | 'error' | 'info' | 'success' | 'warning' | string | 'primary' |
disabled | no | bool | — |
disableRipple | no | bool | false |
icon | no | node | <RadioButtonIcon /> |
id | no | string | — |
name | no | string | — |
onChange | no | func | — |
required | no | bool | false |
size | no | 'medium' | 'small' | string | 'medium' |
slotProps | no | { input?: func | object, root?: func | object } | {} |
slots | no | { input?: elementType, root?: elementType } | {} |
sx | no | Array<func | object | bool> | func | object | — |
value | no | any | — |
RadioGroup
import RadioGroup from '@mui/material/RadioGroup';
import { RadioGroup } from '@mui/material';
Native inheritance: FormGroup. Parent/DOM props are not fabricated as additional own props.
| Prop | Required | Upstream metadata type / constraint | Metadata default |
|---|---|---|---|
children | no | node | — |
defaultValue | no | any | — |
name | no | string | — |
onChange | no | func | — |
value | no | any | — |
FormControl
import FormControl from '@mui/material/FormControl';
import { FormControl } from '@mui/material';
| Prop | Required | Upstream metadata type / constraint | Metadata default |
|---|---|---|---|
children | no | node | — |
classes | no | object | — |
color | no | 'primary' | 'secondary' | 'error' | 'info' | 'success' | 'warning' | string | 'primary' |
component | no | elementType | — |
disabled | no | bool | false |
error | no | bool | false |
focused | no | bool | — |
fullWidth | no | bool | false |
hiddenLabel | no | bool | false |
margin | no | 'dense' | 'none' | 'normal' | 'none' |
required | no | bool | false |
size | no | 'medium' | 'small' | string | 'medium' |
sx | no | Array<func | object | bool> | func | object | — |
variant | no | 'filled' | 'outlined' | 'standard' | 'outlined' |
FormLabel
import FormLabel from '@mui/material/FormLabel';
import { FormLabel } from '@mui/material';
| Prop | Required | Upstream metadata type / constraint | Metadata default |
|---|---|---|---|
children | no | node | — |
classes | no | object | — |
color | no | 'error' | 'info' | 'primary' | 'secondary' | 'success' | 'warning' | string | — |
component | no | elementType | — |
disabled | no | bool | — |
error | no | bool | — |
filled | no | bool | — |
focused | no | bool | — |
required | no | bool | — |
sx | no | Array<func | object | bool> | func | object | — |
FormControlLabel
import FormControlLabel from '@mui/material/FormControlLabel';
import { FormControlLabel } from '@mui/material';
| Prop | Required | Upstream metadata type / constraint | Metadata default |
|---|---|---|---|
control | yes | element | — |
checked | no | bool | — |
classes | no | object | — |
disabled | no | bool | — |
disableTypography | no | bool | — |
inputRef | no | ref | — |
label | no | node | — |
labelPlacement | no | 'bottom' | 'end' | 'start' | 'top' | 'end' |
onChange | no | func | — |
required | no | bool | — |
slotProps | no | { typography?: func | object } | {} |
slots | no | { typography?: elementType } | {} |
sx | no | Array<func | object | bool> | func | object | — |
value | no | any | — |
Native source declarations
Declarations/imports are extracted from pinned source without flattening unions or external inheritance. Original English comments/types are source reference, not a claim of translated upstream prose. Shared types stay in their native packages.
vendor/src/Radio/Radio.d.ts
import * as React from 'react';
import { SxProps } from '@mui/system';
import { OverridableStringUnion } from '@mui/types';
import { Theme } from '../styles';
import { InternalStandardProps as StandardProps } from '../internal';
import { CreateSlotsAndSlotProps, SlotProps } from '../utils/types';
import { SwitchBaseProps } from '../internal/SwitchBase';
import { RadioClasses } from './radioClasses';
export interface RadioPropsSizeOverrides {}
export interface RadioPropsColorOverrides {}
export interface RadioRootSlotPropsOverrides {}
export interface RadioInputSlotPropsOverrides {}
export interface RadioSlots {
/**
* The component that renders the root slot.
* @default SwitchBase
*/
root: React.ElementType;
/**
* The component that renders the input slot.
* @default SwitchBase's input
*/
input: React.ElementType;
}
export type RadioSlotsAndSlotProps = CreateSlotsAndSlotProps<
RadioSlots,
{
/**
* Props forwarded to the root slot.
* By default, the available props are based on the span element.
*/
root: SlotProps<
React.ElementType<SwitchBaseProps>,
RadioRootSlotPropsOverrides,
RadioOwnerState
>;
/**
* Props forwarded to the input slot.
* By default, the available props are based on the input element.
*/
input: SlotProps<'input', RadioInputSlotPropsOverrides, RadioOwnerState>;
}
>;
export interface RadioProps
extends
StandardProps<
SwitchBaseProps,
'checkedIcon' | 'color' | 'icon' | 'type' | 'slots' | 'slotProps'
>,
RadioSlotsAndSlotProps {
/**
* The icon to display when the component is checked.
* @default <RadioButtonIcon checked />
*/
checkedIcon?: React.ReactNode;
/**
* Override or extend the styles applied to the component.
*/
classes?: Partial<RadioClasses> | undefined;
/**
* The color of the component.
* It supports both default and custom theme colors, which can be added as shown in the
* [palette customization guide](https://mui.com/material-ui/customization/palette/#custom-colors).
* @default 'primary'
*/
color?:
| OverridableStringUnion<
'primary' | 'secondary' | 'error' | 'info' | 'success' | 'warning' | 'default',
RadioPropsColorOverrides
>
| undefined;
/**
* If `true`, the component is disabled.
*/
disabled?: boolean | undefined;
/**
* The icon to display when the component is unchecked.
* @default <RadioButtonIcon />
*/
icon?: React.ReactNode;
/**
* The size of the component.
* `small` is equivalent to the dense radio styling.
* @default 'medium'
*/
size?: OverridableStringUnion<'small' | 'medium', RadioPropsSizeOverrides> | undefined;
/**
* The system prop that allows defining system overrides as well as additional CSS styles.
*/
sx?: SxProps<Theme> | undefined;
}
export interface RadioOwnerState extends Omit<RadioProps, 'slots' | 'slotProps'> {}
export default function Radio(props: RadioProps): React.JSX.Element;
vendor/src/RadioGroup/RadioGroup.d.ts
import * as React from 'react';
import { FormGroupProps } from '../FormGroup';
export interface RadioGroupProps extends Omit<FormGroupProps, 'onChange'> {
/**
* The default value. Use when the component is not controlled.
*/
defaultValue?: any;
/**
* 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.
*/
name?: string | undefined;
/**
* Callback fired when a radio button is selected.
*
* @param {React.ChangeEvent<HTMLInputElement>} event The event source of the callback.
* @param {string} value The value of the selected radio button.
* You can pull out the new value by accessing `event.target.value` (string).
*/
onChange?: ((event: React.ChangeEvent<HTMLInputElement>, value: string) => void) | undefined;
/**
* Value of the selected radio button. The DOM API casts this to a string.
*/
value?: any;
}
export default function RadioGroup(props: RadioGroupProps): React.JSX.Element;
vendor/src/FormControl/FormControl.d.ts
import * as React from 'react';
import { SxProps } from '@mui/system';
import { OverridableStringUnion } from '@mui/types';
import { OverridableComponent, OverrideProps } from '../OverridableComponent';
import { Theme } from '../styles';
import { FormControlClasses } from './formControlClasses';
export interface FormControlPropsSizeOverrides {}
export interface FormControlPropsColorOverrides {}
export interface FormControlOwnProps {
/**
* The content of the component.
*/
children?: React.HTMLAttributes<HTMLDivElement>['children'] | undefined;
/**
* Override or extend the styles applied to the component.
*/
classes?: Partial<FormControlClasses> | undefined;
/**
* The color of the component.
* It supports both default and custom theme colors, which can be added as shown in the
* [palette customization guide](https://mui.com/material-ui/customization/palette/#custom-colors).
* @default 'primary'
*/
color?:
| OverridableStringUnion<
'primary' | 'secondary' | 'error' | 'info' | 'success' | 'warning',
FormControlPropsColorOverrides
>
| undefined;
/**
* If `true`, the label, input and helper text should be displayed in a disabled state.
* @default false
*/
disabled?: boolean | undefined;
/**
* If `true`, the label is displayed in an error state.
* @default false
*/
error?: boolean | undefined;
/**
* If `true`, the component will take up the full width of its container.
* @default false
*/
fullWidth?: boolean | undefined;
/**
* If `true`, the component is displayed in focused state.
*/
focused?: boolean | undefined;
/**
* If `true`, the label is hidden.
* This is used to increase density for a `FilledInput`.
* Be sure to add `aria-label` to the `input` element.
* @default false
*/
hiddenLabel?: boolean | undefined;
/**
* If `dense` or `normal`, will adjust vertical spacing of this and contained components.
* @default 'none'
*/
margin?: 'dense' | 'normal' | 'none' | undefined;
/**
* If `true`, the label will indicate that the `input` is required.
* @default false
*/
required?: boolean | undefined;
/**
* The size of the component.
* @default 'medium'
*/
size?: OverridableStringUnion<'small' | 'medium', FormControlPropsSizeOverrides> | undefined;
/**
* The system prop that allows defining system overrides as well as additional CSS styles.
*/
sx?: SxProps<Theme> | undefined;
/**
* The variant to use.
* @default 'outlined'
*/
variant?: 'standard' | 'outlined' | 'filled' | undefined;
}
export interface FormControlTypeMap<
AdditionalProps = {},
RootComponent extends React.ElementType = 'div',
> {
props: AdditionalProps & FormControlOwnProps;
defaultComponent: RootComponent;
}
declare const FormControl: OverridableComponent<FormControlTypeMap>;
export type FormControlProps<
RootComponent extends React.ElementType = FormControlTypeMap['defaultComponent'],
AdditionalProps = {},
> = OverrideProps<FormControlTypeMap<AdditionalProps, RootComponent>, RootComponent> & {
component?: React.ElementType | undefined;
};
vendor/src/FormLabel/FormLabel.d.ts
import * as React from 'react';
import { SxProps } from '@mui/system';
import { OverridableStringUnion } from '@mui/types';
import { Theme } from '../styles';
import { OverridableComponent, OverrideProps, OverridableTypeMap } from '../OverridableComponent';
import { FormLabelClasses } from './formLabelClasses';
export interface FormLabelPropsColorOverrides {}
export type FormLabelBaseProps = React.LabelHTMLAttributes<HTMLLabelElement>;
export interface FormLabelOwnProps {
/**
* The content of the component.
*/
children?: React.LabelHTMLAttributes<HTMLLabelElement>['children'] | undefined;
/**
* Override or extend the styles applied to the component.
*/
classes?: Partial<FormLabelClasses> | undefined;
/**
* The color of the component.
* It supports both default and custom theme colors, which can be added as shown in the
* [palette customization guide](https://mui.com/material-ui/customization/palette/#custom-colors).
*/
color?:
| OverridableStringUnion<
'primary' | 'secondary' | 'error' | 'info' | 'success' | 'warning',
FormLabelPropsColorOverrides
>
| undefined;
/**
* If `true`, the label should be displayed in a disabled state.
*/
disabled?: boolean | undefined;
/**
* If `true`, the label is displayed in an error state.
*/
error?: boolean | undefined;
/**
* If `true`, the label should use filled classes key.
*/
filled?: boolean | undefined;
/**
* If `true`, the input of this label is focused (used by `FormGroup` components).
*/
focused?: boolean | undefined;
/**
* If `true`, the label will indicate that the `input` is required.
*/
required?: boolean | undefined;
/**
* The system prop that allows defining system overrides as well as additional CSS styles.
*/
sx?: SxProps<Theme> | undefined;
}
export interface FormLabelTypeMap<
AdditionalProps = {},
RootComponent extends React.ElementType = 'label',
> {
props: AdditionalProps & FormLabelBaseProps & FormLabelOwnProps;
defaultComponent: RootComponent;
}
declare const FormLabel: OverridableComponent<FormLabelTypeMap>;
export interface ExtendFormLabelTypeMap<TypeMap extends OverridableTypeMap> {
props: TypeMap['props'] & Pick<FormLabelOwnProps, 'filled' | 'color'>;
defaultComponent: TypeMap['defaultComponent'];
}
export type FormLabelProps<
RootComponent extends React.ElementType = FormLabelTypeMap['defaultComponent'],
AdditionalProps = {},
> = OverrideProps<FormLabelTypeMap<AdditionalProps, RootComponent>, RootComponent> & {
component?: React.ElementType | undefined;
};
vendor/src/FormControlLabel/FormControlLabel.d.ts
import * as React from 'react';
import { SxProps } from '@mui/system';
import { Theme } from '../styles';
import { InternalStandardProps as StandardProps } from '../internal';
import Typography from '../Typography';
import { FormControlLabelClasses } from './formControlLabelClasses';
import { CreateSlotsAndSlotProps, SlotProps } from '../utils/types';
export interface FormControlLabelSlots {
/**
* The component that renders the label.
* This is unused if `disableTypography` is true.
* @default Typography
*/
typography: React.ElementType;
}
export type FormControlLabelSlotsAndSlotProps = CreateSlotsAndSlotProps<
FormControlLabelSlots,
{
typography: SlotProps<typeof Typography, {}, FormControlLabelProps>;
}
>;
export interface FormControlLabelProps
extends
StandardProps<React.LabelHTMLAttributes<HTMLLabelElement>, 'children' | 'onChange'>,
FormControlLabelSlotsAndSlotProps {
/**
* If `true`, the component appears selected.
*/
checked?: boolean | undefined;
/**
* Override or extend the styles applied to the component.
*/
classes?: Partial<FormControlLabelClasses> | undefined;
/**
* A control element. For instance, it can be a `Radio`, a `Switch` or a `Checkbox`.
*/
control: React.ReactElement<unknown, any>;
/**
* If `true`, the control is disabled.
*/
disabled?: boolean | undefined;
/**
* If `true`, the label is rendered as it is passed without an additional typography node.
*/
disableTypography?: boolean | undefined;
/**
* Pass a ref to the `input` element.
*/
inputRef?: React.Ref<any> | undefined;
/**
* A text or an element to be used in an enclosing label element.
*/
label: React.ReactNode;
/**
* The position of the label.
* @default 'end'
*/
labelPlacement?: 'end' | 'start' | 'top' | 'bottom' | undefined;
name?: string | undefined;
/**
* Callback fired when the state is changed.
*
* @param {React.SyntheticEvent} event The event source of the callback.
* You can pull out the new checked state by accessing `event.target.checked` (boolean).
*/
onChange?: ((event: React.SyntheticEvent, checked: boolean) => void) | undefined;
/**
* If `true`, the label will indicate that the `input` is required.
*/
required?: boolean | undefined;
/**
* The system prop that allows defining system overrides as well as additional CSS styles.
*/
sx?: SxProps<Theme> | undefined;
/**
* The value of the component.
*/
value?: unknown;
}
export default function FormControlLabel(props: FormControlLabelProps): React.JSX.Element;
Post-install acceptance
Run strict types, production build and real interactions. Check keyboard labels/focus, disabled/error/read-only semantics where natively supported, both themes, narrow screens and reduced motion. Verify callbacks against the real host data; do not declare installation complete from copying a prompt. Initialization fixtures also require server HTML and warning-free hydration.
Source and license
https://github.com/mui/material-ui/tree/809a7717b4c050ba3f69b75300689f07c050a16e
MIT · @mui/material@9.4.0. Vendor originals and license are preserved. Full original upstream prose remains in vendor/docs and is not represented as fully translated.