跳转到内容

🎉 v5 beta is out! Head to the v5 documentation to get started.

FormHelperText API

The API documentation of the FormHelperText React component. Learn more about the props and the CSS customization points.

Import

import FormHelperText from '@material-ui/core/FormHelperText';
// or
import { FormHelperText } from '@material-ui/core';

You can learn more about the difference by reading this guide.

Component name

The MuiFormHelperText name can be used for providing default props or style overrides at the theme level.

Props

Name Type Default Description
children node The content of the component.
If ' ' is provided, the component reserves one line height for displaying a future message.
classes object Override or extend the styles applied to the component. See CSS API below for more details.
component elementType 'p' The component used for the root node. Either a string to use a HTML element or a component.
disabled bool If true, the helper text should be displayed in a disabled state.
error bool If true, helper text should be displayed in an error state.
filled bool If true, the helper text should use filled classes key.
focused bool 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.
required bool If true, the helper text should use required classes key.
variant 'filled'
| 'outlined'
| 'standard'
The variant to use.

The ref is forwarded to the root element.

Any other props supplied will be provided to the root element (native element).

CSS

Rule name Global class Description
root .MuiFormHelperText-root Styles applied to the root element.
error .Mui-error Pseudo-class applied to the root element if error={true}.
disabled .Mui-disabled Pseudo-class applied to the root element if disabled={true}.
marginDense .MuiFormHelperText-marginDense Styles applied to the root element if margin="dense".
contained .MuiFormHelperText-contained Styles applied to the root element if variant="filled" or variant="outlined".
focused .Mui-focused Pseudo-class applied to the root element if focused={true}.
filled .MuiFormHelperText-filled Pseudo-class applied to the root element if filled={true}.
required .Mui-required Pseudo-class applied to the root element if required={true}.

You can override the style of the component thanks to one of these customization points:

If that's not sufficient, you can check the implementation of the component for more detail.

Demos