Skip to content
Edit this page

FormControl API

The API documentation of the FormControl React component. Learn more about the properties and the CSS customization points.

import FormControl from '@material-ui/core/FormControl';

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 input can be used within a FormControl.

Props

Name Type Default Description
children node The contents of the form control.
classes object Override or extend the styles applied to the component. See CSS API below for more details.
component elementType 'div' The component used for the root node. Either a string to use a DOM 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 should be displayed in an error state.
fullWidth bool false If true, the component will take up the full width of its container.
margin enum: 'none' |
 'dense' |
 '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.
variant enum: 'standard' |
 'outlined' |
 'filled'
 'standard' The variant to use.

The ref is forwarded to the root element.

Any other properties supplied will be provided to the root element (native element).

CSS

You can override all the class names injected by Material-UI thanks to the classes property. This property accepts the following keys:

Name Description
root Styles applied to the root element.
marginNormal Styles applied to the root element if margin="normal".
marginDense Styles applied to the root element if margin="dense".
fullWidth Styles applied to the root element if fullWidth={true}.

Have a look at the overriding styles with classes section and the implementation of the component for more detail.

If using the overrides key of the theme, you need to use the following style sheet name: MuiFormControl.

Notes

The component is fully StrictMode compatible.

Demos