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

列表項目按鈕API

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

範例

匯入

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

閱讀這份關於最小化 bundle 大小的指南,以瞭解差異。

Props

ButtonBase 元件的 Props 也可使用。

名稱類型預設描述
alignItems'center'
| 'flex-start'
'center'

定義 align-items 樣式屬性。

autoFocusboolfalse

若為 true,列表項目會在首次掛載時取得焦點。當值從 false 變更為 true 時,也會觸發焦點。

childrennode-

若使用 ListItemSecondaryAction,則為元件的內容,且必須是最後一個子元素。

classesobject-

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

詳情請參閱下方的 CSS 類別 API

componentelementType-

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

denseboolfalse

若為 true,則會使用專為鍵盤和滑鼠輸入設計的精簡垂直內距。此 prop 預設為繼承自父 List 元件的值。

disabledboolfalse

若為 true,則停用元件。

disableGuttersboolfalse

若為 true,則移除左右內距。

dividerboolfalse

若為 true,則在列表項目的底部新增 1px 的淺色邊框。

focusVisibleClassNamestring-

此 prop 可協助識別哪個元素具有鍵盤焦點。當元素透過鍵盤互動取得焦點時,將會套用類別名稱。它是 CSS :focus-visible 選取器 的 polyfill。此處 說明了使用此功能的理由。如果需要,可以使用 polyfillfocus-visible 類別套用至其他元件。

selectedboolfalse

用於套用選取樣式。

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

系統 prop,可定義系統覆寫以及其他 CSS 樣式。

詳情請參閱 sx 頁面

ref 會轉發到根元素。

繼承

雖然上方未明確記載,但 ButtonBase 元件的 props 也可在 ListItemButton 中使用。您可以善用此功能來 鎖定巢狀元件

主題預設 props

您可以使用 MuiListItemButton 透過主題變更此元件的預設 props。

CSS 類別

這些類別名稱對於使用 CSS 設定樣式很有用。它們會在觸發特定狀態時套用至元件的 slot。

類別名稱規則名稱描述
.Mui-disableddisabled={true},則套用至內部 component 元素的狀態類別。
.Mui-focusVisible套用至元件 focusVisibleClassName prop 的狀態類別。
.Mui-selectedselected={true},則套用至根元素的狀態類別。
.MuiListItemButton-alignItemsFlexStartalignItemsFlexStartalignItems="flex-start",則套用至元件元素的樣式。
.MuiListItemButton-densedense若為 dense,則套用至元件元素的樣式。
.MuiListItemButton-dividerdividerdivider={true},則套用至內部 component 元素的樣式。
.MuiListItemButton-guttersgutters除非 disableGutters={true},否則套用至內部 component 元素的樣式。
.MuiListItemButton-rootroot套用至根元素的樣式。

您可以使用下列其中一種客製化選項覆寫元件的樣式

原始碼

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