FormHelperText API
The API documentation of the FormHelperText React component. Learn more about the properties and the CSS customization points.
import FormHelperText from '@material-ui/core/FormHelperText';Props
| Name | Type | Default | Description |
|---|---|---|---|
| children | node | The content of the component. | |
| classes | object | Override or extend the styles applied to the component. See CSS API below for more details. | |
| component | elementType | 'p' | The component used for the root node. Either a string to use a DOM element or a component. |
| disabled | bool | If true, the helper text should be displayed in a disabled state. |
|
| error | bool | If true, helper text should be displayed in an error state. |
|
| filled | bool | If true, the helper text should use filled classes key. |
|
| focused | bool | If true, the helper text should use focused classes key. |
|
| margin | enum: 'dense' |
If dense, will adjust vertical spacing. This is normally obtained via context from FormControl. |
|
| required | bool | If true, the helper text should use required classes key. |
|
| variant | enum: 'standard' | 'outlined' | 'filled' |
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. |
| error | Styles applied to the root element if error={true}. |
| disabled | Styles applied to the root element if disabled={true}. |
| marginDense | Styles applied to the root element if margin="dense". |
| contained | Styles applied to the root element if variant="filled" or variant="outlined". |
| focused | Styles applied to the root element if focused={true}. |
| filled | Styles applied to the root element if filled={true}. |
| required | Styles applied to the root element if required={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: MuiFormHelperText.
Notes
The component is fully StrictMode compatible.