Skip to content
Edit this page

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

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
sx

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

The following class names are useful for styling with CSS (the state classes are marked).
To learn more, visit the component customization page.


.MuiFormHelperText-rootroot

Styles applied to the root element.

.Mui-errorerrorSTATE

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

.Mui-disableddisabledSTATE

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

.MuiFormHelperText-sizeSmallsizeSmall

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

.MuiFormHelperText-containedcontained

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

.Mui-focusedfocusedSTATE

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

.MuiFormHelperText-filledfilled

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

.Mui-requiredrequiredSTATE

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

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