Skip to content
Edit this page

FormControl API

API documentation for the React FormControl component. Learn about the available props, and the CSS API.

Import

import FormControl from '@material-ui/core/FormControl';
// or
import { FormControl } from '@material-ui/core';
You can 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 create visual inconsistencies. For instance, only one input can be focused at the same time, the state shouldn't be shared.

Component name

The name MuiFormControl can be used when providing default props or style overrides in the theme.

Props

NameTypeDefaultDescription
childrennodeThe content of the component.
classesobjectOverride or extend the styles applied to the component. See CSS API below for more details.
color'primary'
| 'secondary'		'primary'The color of the component. It supports those theme colors that make sense for this component.
componentelementTypeThe component used for the root node. Either a string to use a HTML element or a component.
disabledboolfalseIf true, the label, input and helper text should be displayed in a disabled state.
errorboolfalseIf true, the label is displayed in an error state.
focusedboolfalseIf true, the component is displayed in focused state.
fullWidthboolfalseIf true, the component will take up the full width of its container.
hiddenLabelboolfalseIf 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.
requiredboolfalseIf true, the label will indicate that the input is required.
size'medium'
| 'small'		'medium'The size of the component.
variant'filled'
| 'outlined'
| 'standard'		'standard'The variant to use.

The ref is forwarded to the root element.
Any other props supplied will be provided to the root element (native element).

CSS

Rule nameGlobal classDescription
root.MuiFormControl-rootStyles applied to the root element.
marginNormal.MuiFormControl-marginNormalStyles applied to the root element if margin="normal".
marginDense.MuiFormControl-marginDenseStyles applied to the root element if margin="dense".
fullWidth.MuiFormControl-fullWidthStyles applied to the root element if fullWidth={true}.

You can override the style of the component using one of these customization options: If that isn't sufficient, you can check the implementation of the component for more detail.

Demos