TableSortLabelAPI

React TableSortLabel 组件的 API 参考文档。了解此导出模块的 props、CSS 和其他 API。

演示

有关此 React 组件用法的示例和详细信息，请访问组件演示页面

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

一个基于按钮的标签，用于放置在 TableCell 中以进行列排序。

ButtonBase 组件的 Props 也可用。

名称	类型	默认值	描述
active	bool	false	如果 `true`，标签将具有激活样式（对于排序的列应为 true）。
children	node	-	标签内容，箭头将自动追加。
classes	object	-	覆盖或扩展应用于组件的样式。有关更多详细信息，请参阅下面的 CSS 类 API。
direction	'asc' \| 'desc'	'asc'	当前的排序方向。
hideSortIcon	bool	false	当 active 为 false 时，隐藏排序图标。
IconComponent	elementType	ArrowDownwardIcon	要使用的排序图标。
slotProps	{ icon?: func \| object, root?: func \| object }	{}	用于每个内部插槽的 props。
slots	{ icon?: elementType, root?: elementType }	{}	用于每个内部插槽的组件。
sx	Array<func \| object \| bool> \| func \| object	-	允许定义系统覆盖以及其他 CSS 样式的系统 prop。有关更多详细信息，请参阅 `sx` 页面。

ref 被转发到根元素。

虽然上面没有明确记录，但 ButtonBase 组件的 props 也可在 TableSortLabel 中使用。您可以利用这一点来定位嵌套组件。

您可以使用 MuiTableSortLabel 通过主题更改此组件的默认 props。

插槽名称	类名	默认组件	描述
root	.MuiTableSortLabel-root	`span`	渲染 root 插槽的组件。
icon	.MuiTableSortLabel-icon	`ArrowDownwardIcon`	渲染 icon 插槽的组件。

这些类名对于使用 CSS 进行样式设置很有用。当触发特定状态时，它们会应用于组件的插槽。

类名	规则名称	描述
.Mui-active		如果 `active={true}`，则应用于根元素的状态类。
.MuiTableSortLabel-directionAsc	directionAsc	如果 `direction="asc"`，则应用于根元素的样式。
.MuiTableSortLabel-directionDesc	directionDesc	如果 `direction="desc"`，则应用于根元素的样式。
.MuiTableSortLabel-iconDirectionAsc	iconDirectionAsc	如果 `direction="asc"`，则应用于 icon 组件的样式。已弃用－请结合使用 .MuiTableSortLabel-icon 和 .MuiTableSortLabel-directionAsc 类。有关更多详细信息，请参阅从已弃用的 API 迁移。
.MuiTableSortLabel-iconDirectionDesc	iconDirectionDesc	如果 `direction="desc"`，则应用于 icon 组件的样式。已弃用－请结合使用 .MuiTableSortLabel-icon 和 .MuiTableSortLabel-directionDesc 类。有关更多详细信息，请参阅从已弃用的 API 迁移。

您可以使用以下自定义选项之一来覆盖组件的样式

如果您在此页面中找不到所需信息，请考虑查看组件的实现以获取更多详细信息。