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:

Input

Import

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

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.

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.

Type:

{ root?: elementType }

Default:

{}

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

Type:

Array<func | object | bool> | func | object

The ref is forwarded to the root element.

Theme default props

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

Slots

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

root'p'Required

Global class: .MuiFormHelperText-root

Description: The component that renders the 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.

Have any feedback about this new API display design?

We've heard from you and iterated on making the design of API content documentation more scalable and easier to parse! We value your input, so please don't hesitate to share any additional feedback you may have.