ListItemButtonAPI
React ListItemButton 組件的 API 參考文件。瞭解此匯出模組的 props、CSS 和其他 API。
示範
導入
import ListItemButton from '@mui/joy/ListItemButton';
// or
import { ListItemButton } from '@mui/joy';
原生組件的 props 也可使用。
名稱 | 類型 | 預設值 | 描述 |
---|---|---|---|
action | func | { current?: { focusVisible: func } } | - | 用於命令式動作的 ref。目前僅支援 |
autoFocus | bool | false | 若為 |
children | node | - | 組件的內容。 |
color | 'danger' | 'neutral' | 'primary' | 'success' | 'warning' | string | 'neutral' | 組件的顏色。它支援對此組件有意義的那些主題色彩。 若要瞭解如何新增自己的色彩,請查看主題組件—擴充色彩。 |
component | elementType | - | 用於根節點的組件。可以是字串以使用 HTML 元素或組件。 |
disabled | bool | false | 若為 |
focusVisibleClassName | string | - | 此 prop 可以協助識別哪個元素具有鍵盤焦點。當元素透過鍵盤互動取得焦點時,將套用類別名稱。它是 CSS :focus-visible 選取器的 polyfill。此處說明了使用此功能的理由。如果需要,可以使用 polyfill 將 |
orientation | 'horizontal' | 'vertical' | 'horizontal' | 內容方向流。 |
selected | bool | false | 若為 |
slotProps | { root?: func | object } | {} | 用於內部每個插槽的 props。 |
slots | { root?: elementType } | {} | 用於內部每個插槽的組件。 如需更多詳細資訊,請參閱下方的插槽 API。 |
sx | Array<func | object | bool> | func | object | - | 系統 prop,允許定義系統覆寫以及其他 CSS 樣式。 如需更多詳細資訊,請參閱 |
variant | 'outlined' | 'plain' | 'soft' | 'solid' | string | 'plain' | 要使用的全域 variant。 若要瞭解如何新增自己的 variants,請查看主題組件—擴充 variants。 |
ref
會轉發到根元素。主題預設 props
您可以使用 JoyListItemButton
透過主題變更此組件的預設 props。
若要瞭解如何自訂插槽,請查看覆寫組件結構指南。
插槽名稱 | 類別名稱 | 預設組件 | 描述 |
---|---|---|---|
root | .MuiListItemButton-root | 'div' | 呈現根的組件。 |
這些類別名稱對於使用 CSS 設定樣式很有用。當觸發特定狀態時,它們會套用至組件的插槽。
類別名稱 | 規則名稱 | 描述 |
---|---|---|
.Mui-disabled | 如果 disabled={true} ,則套用至內部 component 元素的狀態類別。 | |
.Mui-focusVisible | 套用至 component 的 focusVisibleClassName prop 的狀態類別。 | |
.Mui-selected | 如果 selected={true} ,則套用至根元素的狀態類別。 | |
.MuiListItemButton-colorContext | colorContext | 如果 color="context" ,則套用至根元素的類別名稱。 |
.MuiListItemButton-colorDanger | colorDanger | 如果 color="danger" ,則套用至根元素的類別名稱。 |
.MuiListItemButton-colorNeutral | colorNeutral | 如果 color="neutral" ,則套用至根元素的類別名稱。 |
.MuiListItemButton-colorPrimary | colorPrimary | 如果 color="primary" ,則套用至根元素的類別名稱。 |
.MuiListItemButton-colorSuccess | colorSuccess | 如果 color="success" ,則套用至根元素的類別名稱。 |
.MuiListItemButton-colorWarning | colorWarning | 如果 color="warning" ,則套用至根元素的類別名稱。 |
.MuiListItemButton-horizontal | horizontal | 如果 orientation="horizontal" ,則套用至根元素的類別名稱。 |
.MuiListItemButton-variantOutlined | variantOutlined | 如果 variant="outlined" ,則套用至根元素的狀態類別。 |
.MuiListItemButton-variantPlain | variantPlain | 如果 variant="plain" ,則套用至根元素的狀態類別。 |
.MuiListItemButton-variantSoft | variantSoft | 如果 variant="soft" ,則套用至根元素的狀態類別。 |
.MuiListItemButton-variantSolid | variantSolid | 如果 variant="solid" ,則套用至根元素的狀態類別。 |
.MuiListItemButton-vertical | vertical | 如果 orientation="vertical" ,則套用至根元素的類別名稱。 |
您可以使用下列其中一種自訂選項覆寫組件的樣式
- 使用全域類別名稱。
- 使用規則名稱作為自訂主題中組件的
styleOverrides
屬性的一部分。
原始碼
如果您在此頁面中找不到資訊,請考慮查看組件的實作以取得更多詳細資訊。