SheetAPI
React Sheet 元件的 API 參考文件。瞭解此匯出模組的 props、CSS 和其他 API。
範例
Import
import Sheet from '@mui/joy/Sheet';
// or
import { Sheet } from '@mui/joy';
閱讀關於最小化 bundle size 的指南,以瞭解差異。
原生元件的 Props 也可使用。
名稱 | 類型 | 預設值 | 描述 |
---|---|---|---|
children | node | - | 元件的內容。 |
color | 'danger' | 'neutral' | 'primary' | 'success' | 'warning' | string | 'neutral' | 元件的顏色。它支援對此元件有意義的主題顏色。 若要瞭解如何新增自己的顏色,請查看主題元件—延伸色彩。 |
component | elementType | - | 用於根節點的元件。可以是字串 (用於 HTML 元素) 或元件。 |
invertedColors | bool | false | 若 |
slotProps | { root?: func | object } | {} | 用於每個內部 slot 的 props。 |
slots | { root?: elementType } | {} | 用於每個內部 slot 的元件。 請參閱下方的Slots API 以取得更多詳細資訊。 |
sx | Array<func | object | bool> | func | object | - | 系統 prop,允許定義系統覆寫以及額外的 CSS 樣式。 請參閱 `sx` 頁面以取得更多詳細資訊。 |
variant | 'outlined' | 'plain' | 'soft' | 'solid' | string | 'plain' | 要使用的全域 variant。 若要瞭解如何新增自己的 variant,請查看主題元件—延伸 variant。 |
ref
會轉發到根元素。主題預設 props
您可以使用 JoySheet
透過主題變更此元件的預設 props。
若要瞭解如何自訂 slot,請查看覆寫元件結構指南。
Slot 名稱 | 類別名稱 | 預設元件 | 描述 |
---|---|---|---|
root | .MuiSheet-root | 'div' | 轉譯 root 的元件。 |
這些類別名稱對於使用 CSS 設定樣式很有用。當觸發特定狀態時,它們會套用至元件的 slot。
類別名稱 | 規則名稱 | 描述 |
---|---|---|
.MuiSheet-colorContext | colorContext | 當觸發顏色反轉時,套用至根元素的類別名稱。 |
.MuiSheet-colorDanger | colorDanger | 若 color="danger" ,套用至根元素的類別名稱。 |
.MuiSheet-colorNeutral | colorNeutral | 若 color="neutral" ,套用至根元素的類別名稱。 |
.MuiSheet-colorPrimary | colorPrimary | 若 color="primary" ,套用至根元素的類別名稱。 |
.MuiSheet-colorSuccess | colorSuccess | 若 color="success" ,套用至根元素的類別名稱。 |
.MuiSheet-colorWarning | colorWarning | 若 color="warning" ,套用至根元素的類別名稱。 |
.MuiSheet-variantOutlined | variantOutlined | 若 variant="outlined" ,套用至根元素的類別名稱。 |
.MuiSheet-variantPlain | variantPlain | 若 variant="plain" ,套用至根元素的類別名稱。 |
.MuiSheet-variantSoft | variantSoft | 若 variant="soft" ,套用至根元素的類別名稱。 |
.MuiSheet-variantSolid | variantSolid | 若 variant="solid" ,套用至根元素的類別名稱。 |
您可以使用以下自訂選項之一覆寫元件的樣式
- 使用全域類別名稱。
- 在自訂主題中使用規則名稱作為元件
styleOverrides
屬性的一部分。
原始碼
如果您在此頁面中找不到資訊,請考慮查看元件的實作以取得更多詳細資訊。