跳到主要內容跳到主要內容

FormHelperTextAPI

React FormHelperText 元件的 API 參考文件。瞭解此匯出模組的 props、CSS 和其他 API。

示範

匯入

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

若要瞭解差異,請閱讀此關於最小化套件大小的指南

Props

原生元件的 Props 也可使用。

名稱類型描述
childrennode

元件的內容。
如果提供 ' ',元件會保留一行高度以顯示未來的訊息。

classesobject

覆寫或擴充套用至元件的樣式。

請參閱下方的CSS 類別 API 以取得更多詳細資訊。

componentelementType

用於根節點的元件。可以是字串 (使用 HTML 元素) 或元件。

disabledbool

如果為 true,輔助文字應以停用狀態顯示。

errorbool

如果為 true,輔助文字應以錯誤狀態顯示。

filledbool

如果為 true,輔助文字應使用 filled 類別金鑰。

focusedbool

如果為 true,輔助文字應使用 focused 類別金鑰。

margin'dense'

如果為 dense,將調整垂直間距。這通常透過 FormControl 的 context 取得。

requiredbool

如果為 true,輔助文字應使用 required 類別金鑰。

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

允許定義系統覆寫以及額外 CSS 樣式的系統 prop。

請參閱 `sx` 頁面 以取得更多詳細資訊。

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

要使用的變體。

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",則套用至根元素的樣式。

您可以使用下列其中一種自訂選項來覆寫元件的樣式

原始碼

如果您在此頁面中找不到資訊,請考慮查看元件的實作以取得更多詳細資訊。