跳到主要内容跳到主要内容

FormHelperTextAPI

React FormHelperText 组件的 API 参考文档。了解此导出模块的 props、CSS 和其他 API。

演示

导入

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

阅读这篇关于最小化包大小的指南,了解它们之间的区别。

Props

原生组件的 Props 也可用。

名称类型描述
children节点

组件的内容。
如果提供 ' ',组件将保留一行高度以显示未来的消息。

classes对象

覆盖或扩展应用于组件的样式。

有关更多详细信息,请参阅下面的 CSS classes API。

component元素类型

用于根节点的组件。可以是用于 HTML 元素的字符串或组件。

disabled布尔值

如果为 true,则辅助文本应以禁用状态显示。

error布尔值

如果为 true,则辅助文本应以错误状态显示。

filled布尔值

如果为 true,则辅助文本应使用 filled 类键。

focused布尔值

如果为 true,则辅助文本应使用 focused 类键。

margin'dense'

如果为 dense,将调整垂直间距。这通常通过 FormControl 的上下文获得。

required布尔值

如果为 true,则辅助文本应使用 required 类键。

sxArray<func
| object
| bool>
| func
| object

系统属性,允许定义系统覆盖以及其他 CSS 样式。

有关更多详细信息,请参阅 `sx` 页面。

variant'filled'
| 'outlined'
| 'standard'
| string

要使用的 variant。

ref 被转发到根元素。

主题默认 props

您可以使用 MuiFormHelperText 通过主题更改此组件的默认 props。

CSS 类

这些类名对于使用 CSS 进行样式设置很有用。当特定状态被触发时,它们会被应用到组件的插槽。

类名规则名描述
.Mui-disabled如果 disabled={true},则应用于根元素的状态类。
.Mui-error如果 error={true},则应用于根元素的状态类。
.Mui-focused如果 focused={true},则应用于根元素的状态类。
.Mui-required如果 required={true},则应用于根元素的状态类。
.MuiFormHelperText-containedcontained如果 variant="filled" 或 variant="outlined",则应用于根元素的样式。
.MuiFormHelperText-filledfilled如果 filled={true},则应用于根元素的状态类。
.MuiFormHelperText-rootroot应用于根元素的样式。
.MuiFormHelperText-sizeSmallsizeSmall如果 size="small",则应用于根元素的样式。

您可以使用以下定制选项之一覆盖组件的样式

  • 使用全局类名。
  • 在自定义主题中,使用作为组件 styleOverrides 属性一部分的规则名。

源代码

如果您在此页面中找不到信息,请考虑查看组件的实现以获取更多详细信息。