import FormControl from '@mui/material/FormControl';
// or
import { FormControl } from '@mui/material';
Learn about the difference by reading this guide on minimizing bundle size.
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:
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.
| 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. |
| color | ‘primary’ | ‘secondary’ | ‘error’ | ‘info’ | ‘success’ | ‘warning’ | string | ‘primary’ | The color of the component. It supports both default and custom theme colors, which can be added as shown in the palette customization guide. |
| 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 | - | 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 | 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. |
| variant | ‘filled’ | ‘outlined’ | ‘standard’ | ‘outlined’ | The variant to use. |
The ref is forwarded to the root element.
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.
| Class name | Rule name | Description |
|---|---|---|
| .MuiFormControl-fullWidth | fullWidth | Styles applied to the root element if fullWidth={true}. |
| .MuiFormControl-marginDense | marginDense | Styles applied to the root element if margin="dense". |
| .MuiFormControl-marginNormal | marginNormal | Styles applied to the root element if margin="normal". |
| .MuiFormControl-root | root | Styles applied to the root element. |
You can override the style of the component using one of these customization options:
styleOverrides property in a custom theme.If you did not find the information in this page, consider having a look at the implementation of the component for more detail.