StepAPI
React Step 元件的 API 參考文件。瞭解此匯出模組的 props、CSS 和其他 API。
示範
匯入
import Step from '@mui/material/Step';
// or
import { Step } from '@mui/material';
閱讀關於最小化 bundle size 的指南,以瞭解差異。
原生元件的 Props 也可使用。
名稱 | 類型 | 預設值 | 描述 |
---|---|---|---|
active | bool | - | 設定 step 為 active。會傳遞至子元件。 |
children | node | - | 應為 |
classes | object | - | 覆寫或擴充套用至元件的樣式。 請參閱下方CSS classes API 以取得更多詳細資訊。 |
completed | bool | - | 將 step 標記為 completed。會傳遞至子元件。 |
component | elementType | - | 用於根節點的元件。可以是字串 (用於 HTML 元素) 或元件。 |
disabled | bool | - | 若為 |
expanded | bool | false | 展開 step。 |
index | integer | - | step 的位置。此 prop 預設為從父 Stepper 元件繼承的值。 |
last | bool | - | 若為 |
sx | Array<func | object | bool> | func | object | - | 系統 prop,允許定義系統覆寫以及額外的 CSS 樣式。 請參閱 `sx` 頁面 以取得更多詳細資訊。 |
ref
會轉發到根元素。主題預設 props
您可以使用 MuiStep
透過主題變更此元件的預設 props。
這些 class name 對於使用 CSS 設定樣式很有用。當觸發特定狀態時,它們會套用至元件的 slot。
Class name | Rule name | 描述 |
---|---|---|
.Mui-completed | 若 completed={true} ,則套用至根元素的 State class。 | |
.MuiStep-alternativeLabel | alternativeLabel | 若 alternativeLabel={true} ,則套用至根元素的樣式。 |
.MuiStep-horizontal | horizontal | 若 orientation="horizontal" ,則套用至根元素的樣式。 |
.MuiStep-root | root | 套用至根元素的樣式。 |
.MuiStep-vertical | vertical | 若 orientation="vertical" ,則套用至根元素的樣式。 |
您可以使用以下其中一種客製化選項覆寫元件的樣式
- 使用全域 class name。
- 使用 rule name 作為自訂主題中元件的
styleOverrides
屬性的一部分。
原始碼
如果您在此頁面中找不到資訊,請考慮查看元件的實作以取得更多詳細資訊。