Skip to content

FormHelperText API

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

Demos

Import

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

Learn about the difference by reading this guide on minimizing bundle size.

Props

Props of the native component are also available.

NameTypeDescription
childrennode

The content of the component.
If ' ' is provided, the component reserves one line height for displaying a future message.

classesobject

Override or extend the styles applied to the component.

See CSS classes API below for more details.

componentelementType

The component used for the root node. Either a string to use a HTML element or a component.

disabledbool

If true, the helper text should be displayed in a disabled state.

errorbool

If true, helper text should be displayed in an error state.

filledbool

If true, the helper text should use filled classes key.

focusedbool

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.

requiredbool

If true, the helper text should use required classes key.

sxArray<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.

Theme default props

You can use MuiFormHelperText to change the default props of this component with the theme.

CSS classes

These class names are useful for styling with CSS. They are applied to the component's slots when specific states are triggered.

Class nameRule nameDescription
.Mui-disabledState class applied to the root element if disabled={true}.
.Mui-errorState class applied to the root element if error={true}.
.Mui-focusedState class applied to the root element if focused={true}.
.Mui-requiredState class applied to the root element if required={true}.
.MuiFormHelperText-containedcontainedStyles applied to the root element if variant="filled" or variant="outlined".
.MuiFormHelperText-filledfilledState class applied to the root element if filled={true}.
.MuiFormHelperText-rootrootStyles applied to the root element.
.MuiFormHelperText-sizeSmallsizeSmallStyles applied to the root element if size="small".

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

Source code

If you did not find the information in this page, consider having a look at the implementation of the component for more detail.