FormGroup API
API reference docs for the React FormGroup component. Learn about the props, CSS, and other APIs of this exported module.
Demos
Import
import FormGroup from '@mui/material/FormGroup';
// or
import { FormGroup } from '@mui/material';
Learn about the difference by reading this guide on minimizing bundle size.
FormGroup
wraps controls such as Checkbox
and Switch
.
It provides compact row layout.
For the Radio
, you should be using the RadioGroup
component instead of this one.
Props of the native component are also available.
Name | Type | Default | Description |
---|---|---|---|
children | node | - | The content of the component. |
classes | object | - | Override or extend the styles applied to the component. See CSS classes API below for more details. |
row | bool | false | Display group of elements in a compact row. |
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. |
ref
is forwarded to the root element.Theme default props
You can use MuiFormGroup
to change the default props of this component with the theme.
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 |
---|---|---|
.Mui-error | State class applied to the root element if error={true} . | |
.MuiFormGroup-root | root | Styles applied to the root element. |
.MuiFormGroup-row | row | Styles applied to the root element if row={true} . |
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.