FormControl API
API documentation for the React FormControl component. Learn about the available props and the CSS API.
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 create visual inconsistencies.
For instance, only one input can be focused at the same time, the state shouldn't be shared.
Component name
The nameMuiFormControl can be used when providing default props or style overrides in the theme.Props
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 API below for more details. | |
| color | 'primary' | 'secondary' | 'error' | 'info' | 'success' | 'warning' | string | 'primary' | The color of the component. It supports those theme colors that make sense for this component. |
| component | elementType | The component used for the root node. Either a string to use a HTML element or a component. | |
| disabled | bool | false | If true, the label, input and helper text should be displayed in a disabled state. |
| error | bool | false | If true, the label is displayed in an error state. |
| focused | bool | false | If true, the component is displayed in focused state. |
| fullWidth | bool | false | If true, the component will take up the full width of its container. |
| hiddenLabel | bool | false | 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. |
| margin | 'dense' | 'none' | 'normal' | 'none' | If dense or normal, will adjust vertical spacing of this and contained components. |
| required | bool | false | If true, the label will indicate that the input is required. |
| size | 'medium' | 'small' | string | 'medium' | The size of the component. |
| sx | object | The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details. | |
| variant | 'filled' | 'outlined' | 'standard' | 'outlined' | The variant to use. |
The
ref is forwarded to the root element.CSS
| Rule name | Global class | Description |
|---|---|---|
| root | .MuiFormControl-root | Styles applied to the root element. |
| marginNormal | .MuiFormControl-marginNormal | Styles applied to the root element if margin="normal". |
| marginDense | .MuiFormControl-marginDense | Styles applied to the root element if margin="dense". |
| fullWidth | .MuiFormControl-fullWidth | Styles applied to the root element if fullWidth={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
styleOverridesproperty in a custom theme.