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

TableSortLabelAPI

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

範例

匯入

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

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



一個基於按鈕的標籤,用於放置在 TableCell 內以進行欄位排序。

Props

ButtonBase 元件的 props 也可使用。

名稱類型預設值描述
activeboolfalse

若為 true,標籤將具有啟用的樣式(排序欄位應為 true)。

childrennode-

標籤內容,箭頭將自動附加。

classesobject-

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

有關更多詳細資訊,請參閱下方的 CSS 類別 API

direction'asc'
| 'desc'
'asc'

目前的排序方向。

hideSortIconboolfalse

當 active 為 false 時,隱藏排序圖示。

IconComponentelementTypeArrowDownwardIcon

要使用的排序圖示。

slotProps{ icon?: func
| object, root?: func
| object }
{}

用於每個 slot 內部的 props。

slots{ icon?: elementType, root?: elementType }{}

用於每個 slot 內部的元件。

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

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

有關更多詳細資訊,請參閱 sx 頁面

ref 會轉發到根元素。

繼承

雖然上方未明確記載,但 ButtonBase 元件的 props 也可在 TableSortLabel 中使用。您可以利用這點來鎖定巢狀元件

主題預設 props

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

Slots

Slot 名稱類別名稱預設元件描述
root.MuiTableSortLabel-rootspan呈現 root slot 的元件。
icon.MuiTableSortLabel-iconArrowDownwardIcon呈現 icon slot 的元件。

CSS 類別

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

類別名稱規則名稱描述
.Mui-activeactive={true},則套用至 root 元素的狀態類別。
.MuiTableSortLabel-directionAscdirectionAscdirection="asc",則套用至 root 元素的樣式。
.MuiTableSortLabel-directionDescdirectionDescdirection="desc",則套用至 root 元素的樣式。
.MuiTableSortLabel-iconDirectionAsciconDirectionAscdirection="asc",則套用至 icon 元件的樣式。
.MuiTableSortLabel-iconDirectionDesciconDirectionDescdirection="desc",則套用至 icon 元件的樣式。

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

原始碼

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