FormHelperText API
API documentation for the React FormHelperText component. Learn about the available props, and the CSS API.
Import
import FormHelperText from '@material-ui/core/FormHelperText';
// o
import { FormHelperText } from '@material-ui/core';
Component name
The nameMuiFormHelperText
can be used when providing default props or style overrides in the theme.Props
Nombre | Tipo | Por defecto | Descripción |
---|---|---|---|
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 | The component used for the root node. Either a string to use a HTML element or a component. | |
disabled | bool | false | If true , the helper text should be displayed in a disabled state. |
error | bool | false | If true , helper text should be displayed in an error state. |
filled | bool | false | If true , the helper text should use filled classes key. |
focused | bool | false | 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 | false | 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 | Descripción |
---|---|---|
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} . |
sizeSmall | .MuiFormHelperText-sizeSmall | Styles applied to the root element if size="small" . |
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 using one of these customization options:
- With a rule name of the
classes
object prop. - With a global class name.
- With a theme and an
styleOverrides
property.