FormControl
The API documentation of the FormControl React component.
Provides context such as filled/focused/error/required for form inputs.
Relying on the context provides high flexibilty 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
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 | union: string | func | object |
'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. |
Any other properties supplied will be spread to the root element (native element).
CSS API
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 overriding with classes section and the implementation of the component for more detail.
If using the overrides key of the theme as documented
here,
you need to use the following style sheet name: MuiFormControl.