TextareaAPI
React Textarea 元件的 API 參考文件。瞭解此匯出模組的 props、CSS 和其他 API。
範例
Import
import Textarea from '@mui/joy/Textarea';
// or
import { Textarea } from '@mui/joy';閱讀這份關於最小化套件大小的指南，以瞭解差異。
| 名稱 | 類型 | 預設值 | 描述 |
|---|---|---|---|
| color | 'danger' | 'neutral' | 'primary' | 'success' | 'warning' | string | 'neutral' | 元件的顏色。它支援適用於此元件的佈景主題顏色。 若要瞭解如何新增自己的顏色，請查看佈景主題元件—擴充顏色。 |
| endDecorator | node | - | 此輸入的尾隨裝飾。 |
| error | bool | false | 若 |
| maxRows | number | string | - | 要顯示的最大列數。 |
| minRows | number | string | 1 | 要顯示的最小列數。 |
| size | 'sm' | 'md' | 'lg' | string | 'md' | 元件的大小。 若要瞭解如何將自訂大小新增至元件，請查看佈景主題元件—擴充尺寸。 |
| startDecorator | node | - | 此輸入的前導裝飾。 |
| sx | Array<func | object | bool> | func | object | - | 允許定義系統覆寫以及其他 CSS 樣式的系統 prop。 請參閱 `sx` 頁面以瞭解更多詳細資訊。 |
| variant | 'outlined' | 'plain' | 'soft' | 'solid' | string | 'outlined' | 要使用的全域變體。 若要瞭解如何新增自己的變體，請查看佈景主題元件—擴充變體。 |
ref 會轉發到根元素。佈景主題預設 props
您可以使用 JoyTextarea 透過佈景主題變更此元件的預設 props。
若要瞭解如何自訂插槽，請查看覆寫元件結構指南。
| 插槽名稱 | 類別名稱 | 預設元件 | 描述 |
|---|---|---|---|
| root | .MuiTextarea-root | 'div' | 呈現根元素的元件。 |
| textarea | .MuiTextarea-textarea | 'textarea' | 呈現 textarea 的元件。 |
| startDecorator | .MuiTextarea-startDecorator | 'div' | 呈現開始裝飾的元件。 |
| endDecorator | .MuiTextarea-endDecorator | 'div' | 呈現結束裝飾的元件。 |
這些類別名稱對於使用 CSS 設定樣式很有用。當觸發特定狀態時，它們會套用至元件的插槽。
| 類別名稱 | 規則名稱 | 描述 |
|---|---|---|
| .Mui-disabled | 若 disabled={true}，則套用至根元素的類別名稱。 | |
| .Mui-error | 若 error={true}，則套用至根元素的狀態類別。 | |
| .Mui-focused | 若元件處於焦點狀態，則套用至根元素的類別名稱。 | |
| .MuiTextarea-colorContext | colorContext | 當觸發色彩反轉時，套用至根元素的類別名稱。 |
| .MuiTextarea-colorDanger | colorDanger | 若 color="danger"，則套用至根元素的類別名稱。 |
| .MuiTextarea-colorNeutral | colorNeutral | 若 color="neutral"，則套用至根元素的類別名稱。 |
| .MuiTextarea-colorPrimary | colorPrimary | 若 color="primary"，則套用至根元素的類別名稱。 |
| .MuiTextarea-colorSuccess | colorSuccess | 若 color="success"，則套用至根元素的類別名稱。 |
| .MuiTextarea-colorWarning | colorWarning | 若 color="warning"，則套用至根元素的類別名稱。 |
| .MuiTextarea-formControl | formControl | 若元件是 FormControl 的後代，則套用至根元素的類別名稱。 |
| .MuiTextarea-sizeLg | sizeLg | 若 size="lg"，則套用至根元素的類別名稱。 |
| .MuiTextarea-sizeMd | sizeMd | 若 size="md"，則套用至根元素的類別名稱。 |
| .MuiTextarea-sizeSm | sizeSm | 若 size="sm"，則套用至根元素的類別名稱。 |
| .MuiTextarea-variantOutlined | variantOutlined | 若 variant="outlined"，則套用至根元素的類別名稱。 |
| .MuiTextarea-variantPlain | variantPlain | 若 variant="plain"，則套用至根元素的類別名稱。 |
| .MuiTextarea-variantSoft | variantSoft | 若 variant="soft"，則套用至根元素的類別名稱。 |
您可以使用下列自訂選項之一覆寫元件的樣式
- 使用全域類別名稱。
- 在自訂佈景主題中，將規則名稱作為元件
styleOverrides屬性的一部分。
原始碼
如果您在本頁面中找不到資訊，請考慮查看元件的實作以取得更多詳細資訊。