Skip to content
Edit this page

FormControl API

API reference docs for the React FormControl component. Learn about the props, CSS, and other APIs of this exported module.

Demos

For examples and details on the usage of this React component, visit the component demo pages:

Import

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:

  • 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

Props of the native component are also available.

children

The content of the component.

Type:

node
classes

Override or extend the styles applied to the component.

See CSS API below for more details.

Type:

object
color

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'
component

The component used for the root node. Either a string to use a HTML element or a component.

Type:

elementType
disabled

If true, the label, input and helper text should be displayed in a disabled state.

Type:

bool

Default:

false
error

If true, the label is displayed in an error state.

Type:

bool

Default:

false
focused

If true, the component is displayed in focused state.

Type:

bool
fullWidth

If true, the component will take up the full width of its container.

Type:

bool

Default:

false
hiddenLabel

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.

Type:

bool

Default:

false
margin

If dense or normal, will adjust vertical spacing of this and contained components.

Type:

'dense' | 'none' | 'normal'

Default:

'none'
required

If true, the label will indicate that the input is required.

Type:

bool

Default:

false
size

The size of the component.

Type:

'medium' | 'small' | string

Default:

'medium'
sx

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
variant

The variant to use.

Type:

'filled' | 'outlined' | 'standard'

Default:

'outlined'
The 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.

CSS

The following class names are useful for styling with CSS (the state classes are marked).
To learn more, visit the component customization page.


.MuiFormControl-rootroot

Styles applied to the root element.

.MuiFormControl-marginNormalmarginNormal

Styles applied to the root element if margin="normal".

.MuiFormControl-marginDensemarginDense

Styles applied to the root element if margin="dense".

.MuiFormControl-fullWidthfullWidth

Styles applied to the root element if fullWidth={true}.

You can override the style of the component using one of these customization options: