Skip to content
Edit this page

FormHelperText API

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

Import

import FormHelperText from '@material-ui/core/FormHelperText';
// or
import { FormHelperText } from '@material-ui/core';
You can learn about the difference by reading this guide on minimizing bundle size.

Component name

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

Props

NameTypeDefaultDescription
childrennodeThe content of the component.
If ' ' is provided, the component reserves one line height for displaying a future message.
classesobjectOverride or extend the styles applied to the component. See CSS API below for more details.
componentelementTypeThe component used for the root node. Either a string to use a HTML element or a component.
disabledboolfalseIf true, the helper text should be displayed in a disabled state.
errorboolfalseIf true, helper text should be displayed in an error state.
filledboolfalseIf true, the helper text should use filled classes key.
focusedboolfalseIf true, the helper text should use focused classes key.
margin'dense'If dense, will adjust vertical spacing. This is normally obtained via context from FormControl.
requiredboolfalseIf true, the helper text should use required classes key.
variant'filled'
| 'outlined'
| '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.MuiFormHelperText-rootStyles applied to the root element.
error.Mui-errorPseudo-class applied to the root element if error={true}.
disabled.Mui-disabledPseudo-class applied to the root element if disabled={true}.
sizeSmall.MuiFormHelperText-sizeSmallStyles applied to the root element if size="small".
contained.MuiFormHelperText-containedStyles applied to the root element if variant="filled" or variant="outlined".
focused.Mui-focusedPseudo-class applied to the root element if focused={true}.
filled.MuiFormHelperText-filledPseudo-class applied to the root element if filled={true}.
required.Mui-requiredPseudo-class applied to the root element if required={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