FormHelperText API

API reference docs for the React FormHelperText component. Learn about the props, CSS, and other APIs of this exported module.

Demos

For examples and details on the usage of this React component, visit the component demo pages:

import FormHelperText from '@mui/material/FormHelperText';
// or
import { FormHelperText } from '@mui/material';

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

Props of the native component are also available.

Name	Type	Default	Description
children	node		The content of the component. If `' '` is provided, the component reserves one line height for displaying a future message.
classes	object		Override or extend the styles applied to the component. See CSS API below for more details.
component	elementType		The component used for the root node. Either a string to use a HTML element or a component.
disabled	bool	false	If `true`, the helper text should be displayed in a disabled state.
error	bool	false	If `true`, helper text should be displayed in an error state.
filled	bool	false	If `true`, the helper text should use filled classes key.
focused	bool	false	If `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.
required	bool	false	If `true`, the helper text should use required classes key.
sx	Array<func \| object \| bool> \| func \| object		The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.
variant	'filled' \| 'outlined' \| 'standard' \| string		The variant to use.

The ref is forwarded to the root element.

Rule name	Global class	Description
root	.MuiFormHelperText-root	Styles applied to the root element.
error	.Mui-error	State class applied to the root element if `error={true}`.
disabled	.Mui-disabled	State class applied to the root element if `disabled={true}`.
sizeSmall	.MuiFormHelperText-sizeSmall	Styles applied to the root element if `size="small"`.
contained	.MuiFormHelperText-contained	Styles applied to the root element if `variant="filled"` or `variant="outlined"`.
focused	.Mui-focused	State class applied to the root element if `focused={true}`.
filled	.MuiFormHelperText-filled	State class applied to the root element if `filled={true}`.
required	.Mui-required	State class applied to the root element if `required={true}`.

You can override the style of the component using one of these customization options:

With a global class name.
With a rule name as part of the component's styleOverrides property in a custom theme.