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:

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

Props of the native component are also available.

children

The content of the component.

Type:node

component

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

Type:elementType

slotProps

The props used for each slot inside.

Type:{ root?: func | object }

Default:{}

slots

The components used for each slot inside.

See Slots API below for more details.

Type:{ root?: elementType }

Default:{}

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

The ref is forwarded to the root element.

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

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

.MuiFormHelperText-root

Class name applied to the root element.

Rule name:root

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.

To learn how to customize the slot, check out the Overriding component structure guide.

root

The component that renders the root.

Global class: .MuiFormHelperText-root

Default: 'p'