TabsAPI
React Tabs 元件的 API 參考文件。瞭解此匯出模組的 props、CSS 和其他 API。
範例
匯入
import Tabs from '@mui/material/Tabs';
// or
import { Tabs } from '@mui/material';
若要瞭解差異,請閱讀此關於最小化套件大小的指南。
原生元件的 Props 也可使用。
名稱 | 類型 | 預設值 | 描述 |
---|---|---|---|
action | ref | - | 元件掛載時觸發的回呼函式。當您想要以程式設計方式觸發動作時,這非常有用。它支援兩個動作: |
allowScrollButtonsMobile | bool | false | 如果為 |
aria-label | string | - | Tabs 的標籤字串。 |
aria-labelledby | string | - | 以空格分隔的 ID 或 ID 清單,用於標記 Tabs。 |
centered | bool | false | 如果為 |
children | node | - | 元件的內容。 |
classes | object | - | 覆寫或擴充套用至元件的樣式。 請參閱下方CSS 類別 API 以取得更多詳細資訊。 |
component | elementType | - | 用於根節點的元件。可以是字串 (使用 HTML 元素) 或元件。 |
indicatorColor | 'primary' | 'secondary' | string | 'primary' | 決定指示器的顏色。 |
onChange | func | - | 當值變更時觸發的回呼函式。 簽章: function(event: React.SyntheticEvent, value: any) => void
|
orientation | 'horizontal' | 'vertical' | 'horizontal' | 元件方向 (版面配置流動方向)。 |
ScrollButtonComponent | elementType | TabScrollButton | 用於渲染捲動按鈕的元件。 |
scrollButtons | 'auto' | false | true | 'auto' | 決定當標籤頁設定為捲動時,捲動按鈕的行為
預設情況下,捲動按鈕在行動裝置上會隱藏。此行為可以使用 |
selectionFollowsFocus | bool | - | 如果 |
slotProps | { endScrollButtonIcon?: func | object, indicator?: func | object, list?: func | object, root?: func | object, scrollbar?: func | object, scrollButtons?: func | object, scroller?: func | object, startScrollButtonIcon?: func | object } | {} | 用於每個內部插槽的 props。 |
slots | { endScrollButtonIcon?: elementType, EndScrollButtonIcon?: elementType, indicator?: elementType, list?: elementType, root?: elementType, scrollbar?: elementType, scrollButtons?: elementType, scroller?: elementType, startScrollButtonIcon?: elementType, StartScrollButtonIcon?: elementType } | {} | 用於每個內部插槽的元件。 |
sx | Array<func | object | bool> | func | object | - | 系統 prop,允許定義系統覆寫以及額外的 CSS 樣式。 請參閱 `sx` 頁面 以取得更多詳細資訊。 |
TabIndicatorProps | object | {} | 套用至標籤頁指示器元素的 Props。 |
TabScrollButtonProps | object | {} | 套用至 |
textColor | 'inherit' | 'primary' | 'secondary' | 'primary' | 決定 |
value | any | - | 目前選取之 |
variant | 'fullWidth' | 'scrollable' | 'standard' | 'standard' | 決定標籤頁的其他顯示行為
|
visibleScrollbar | bool | false | 如果為 |
ref
會轉發到根元素。主題預設 props
您可以使用 MuiTabs
透過主題變更此元件的預設 props。
插槽名稱 | 類別名稱 | 預設元件 | 描述 |
---|---|---|---|
root | .MuiTabs-root | div | 用於 popper 的元件。 |
scroller | .MuiTabs-scroller | div | 用於 scroller 的元件。 |
list | .MuiTabs-list | div | 用於彈性容器的元件。 |
scrollbar | ScrollbarSize | 用於 scroller 的元件。 | |
indicator | .MuiTabs-indicator | span | 用於標籤頁指示器的元件。 |
scrollButtons | .MuiTabs-scrollButtons | TabScrollButton | 用於捲動按鈕的元件。 |
startScrollButtonIcon | KeyboardArrowLeft | 用於開始捲動按鈕圖示的元件。 | |
endScrollButtonIcon | KeyboardArrowRight | 用於結束捲動按鈕圖示的元件。 |
這些類別名稱對於使用 CSS 設定樣式很有用。當觸發特定狀態時,它們會套用至元件的插槽。
類別名稱 | 規則名稱 | 描述 |
---|---|---|
.MuiTabs-centered | centered | 如果 centered={true} & !variant="scrollable" ,則套用至彈性容器元素的樣式。 |
.MuiTabs-fixed | fixed | 如果 !variant="scrollable" ,則套用至 tablist 元素的樣式 。 |
.MuiTabs-flexContainer | flexContainer | |
.MuiTabs-flexContainerVertical | flexContainerVertical | |
.MuiTabs-hideScrollbar | hideScrollbar | 如果 variant="scrollable" 且 visibleScrollbar={false} ,則套用至 tablist 元素的樣式。 |
.MuiTabs-scrollableX | scrollableX | 如果 variant="scrollable" 且 orientation="horizontal" ,則套用至 tablist 元素的樣式。 |
.MuiTabs-scrollableY | scrollableY | 如果 variant="scrollable" 且 orientation="vertical" ,則套用至 tablist 元素的樣式。 |
.MuiTabs-scrollButtonsHideMobile | scrollButtonsHideMobile | 如果 allowScrollButtonsMobile={true} ,則套用至 ScrollButtonComponent 元件的樣式。 |
.MuiTabs-vertical | vertical | 如果 orientation="vertical" ,則套用至根元素的樣式。 |
您可以使用下列自訂選項之一來覆寫元件的樣式
- 使用全域類別名稱。
- 在自訂主題中使用規則名稱作為元件
styleOverrides
屬性的一部分。
原始碼
如果您在此頁面中找不到資訊,請考慮查看元件的實作以取得更多詳細資訊。