跳转到内容

FormHelperText API

API documentation for the React FormHelperText component. Learn about the available props, and the CSS API.

Import

import FormHelperText from '@mui/material/FormHelperText';
// 或
import { FormHelperText } from '@mui/material';
You can learn about the difference by reading this guide on minimizing bundle size.

Component name

The name MuiFormHelperText can be used when providing default props or style overrides in the theme.

属性

Props of the 原生(Native) component are also available.

名称类型默认值描述
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 API below for more details.
componentelementType
The component used for the root node. Either a string to use a HTML element or a component.
disabledboolfalse
If true, the helper text should be displayed in a disabled state.
errorboolfalse
If true, helper text should be displayed in an error state.
filledboolfalse
If true, the helper text should use filled classes key.
focusedboolfalse
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.
requiredboolfalse
If true, the helper text should use required classes key.
sxArray<func
| object>
| 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'
The variant to use.

ref 则会被传递到根元素中。

CSS

Rule nameGlobal class描述
root.MuiFormHelperText-rootStyles applied to the root element.
error.Mui-errorPseudo-class applied to the root element if error={true}.
disabled.Mui-disabledPseudo-class applied to the root element if disabled={true}.
sizeSmall.MuiFormHelperText-sizeSmallStyles applied to the root element if size="small".
contained.MuiFormHelperText-containedStyles applied to the root element if variant="filled" or variant="outlined".
focused.Mui-focusedPseudo-class applied to the root element if focused={true}.
filled.MuiFormHelperText-filledPseudo-class applied to the root element if filled={true}.
required.Mui-requiredPseudo-class applied to the root element if required={true}.

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

Demos