FormHelperText API
导入
import FormHelperText from '@mui/material/FormHelperText';
// 或
import { FormHelperText } from '@mui/material';
组件名称
在主题中,名称“MuiFormHelperText
”可用于提供默认属性(props),或者样式覆盖属性
原生(Native) 组件的属性也是可用的。
名称 | 类型 | 默认值 | 描述 |
---|---|---|---|
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. |
sx | Array<func | object | bool> | 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' | string | The variant to use. |
ref
则会被传递到根元素中。CSS
规则名称 | 全局类名 | 描述 |
---|---|---|
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} . |
您可以使用组件自定义选项对组件进行个性化:
- 具备 全局类名.
- 在自定义主体中,设定一个规则名称作为组件的
styleOverrides
属性的一部分。