FormControl API
API reference docs for the React FormControl component. Learn about the props, CSS, and other APIs of this exported module.
Component demos
Import
import FormControl from '@mui/material/FormControl';
// or
import { FormControl } from '@mui/material';
Provides context such as filled/focused/error/required for form inputs.
Relying on the context provides high flexibility and ensures that the state always stays
consistent across the children of the FormControl
.
This context is used by the following components:
- FormLabel
- FormHelperText
- Input
- InputLabel
You can find one composition example below and more going to the demos.
<FormControl>
<InputLabel htmlFor="my-input">Email address</InputLabel>
<Input id="my-input" aria-describedby="my-helper-text" />
<FormHelperText id="my-helper-text">We'll never share your email.</FormHelperText>
</FormControl>
⚠️ Only one InputBase
can be used within a FormControl because it creates visual inconsistencies.
For instance, only one input can be focused at the same time, the state shouldn't be shared.
Props of the native component are also available.
Override or extend the styles applied to the component.
See CSS API below for more details.
Type:object
The color of the component. It supports both default and custom theme colors, which can be added as shown in the palette customization guide.
Type:'primary'
| 'secondary'
| 'error'
| 'info'
| 'success'
| 'warning'
| string
Default:'primary'
The component used for the root node. Either a string to use a HTML element or a component.
Type:elementType
If true
, the label, input and helper text should be displayed in a disabled state.
Type:bool
Default:false
If dense
or normal
, will adjust vertical spacing of this and contained components.
Type:'dense'
| 'none'
| 'normal'
Default:'none'
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
ref
is forwarded to the root element.Theme default props
You can use MuiFormControl
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.
Styles applied to the root element if margin="dense"
.
Rule name:marginDense
Styles applied to the root element if margin="normal"
.
Rule name:marginNormal
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.