FormHelperText API

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

Component demos

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

Text Field

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.

children

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

Type:node

classes

Override or extend the styles applied to the component.

See CSS API below for more details.

Type:object

component

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

Type:elementType

disabled

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

Type:bool

error

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

Type:bool

filled

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

Type:bool

focused

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

Type:bool

margin

If dense, will adjust vertical spacing. This is normally obtained via context from FormControl.

Type:'dense'

required

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

Type:bool

The system prop that allows defining system overrides as well as additional CSS styles.

See the `sx` page for more details.

Type:Array<func | object | bool> | func | object

variant

The variant to use.

Type:'filled' | 'outlined' | 'standard' | string

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.

.Mui-disabledSTATE

State class applied to the root element if disabled={true}.

.Mui-errorSTATE

State class applied to the root element if error={true}.

.Mui-focusedSTATE

State class applied to the root element if focused={true}.

.Mui-requiredSTATE

State class applied to the root element if required={true}.

.MuiFormHelperText-contained

Styles applied to the root element if variant="filled" or variant="outlined".

Rule name:contained

.MuiFormHelperText-filled

State class applied to the root element if filled={true}.

Rule name:filled

.MuiFormHelperText-root

Styles applied to the root element.

Rule name:root

.MuiFormHelperText-sizeSmall

Styles applied to the root element if size="small".

Rule name:sizeSmall

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.