TableSortLabel API

API reference docs for the React TableSortLabel component. Learn about the props, CSS, and other APIs of this exported module.

Demos

For examples and details on the usage of this React component, visit the component demo pages:

Table

Import

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

Learn about the difference by reading this guide on minimizing bundle size.

A button based label for placing inside TableCell for column sorting.

Props

Props of the ButtonBase component are also available.

Name	Type	Default	Description
active	bool	false	If `true`, the label will have the active styling (should be true for the sorted column).
children	node	-	Label contents, the arrow will be appended automatically.
classes	object	-	Override or extend the styles applied to the component. See CSS classes API below for more details.
direction	'asc' \| 'desc'	'asc'	The current sort direction.
hideSortIcon	bool	false	Hide sort icon when active is false.
IconComponent	elementType	ArrowDownwardIcon	Sort icon to use.
sx	Array<func \| object \| bool> \| func \| object	-	The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.

The ref is forwarded to the root element.

Inheritance

While not explicitly documented above, the props of the ButtonBase component are also available in TableSortLabel. You can take advantage of this to target nested components.

Theme default props

You can use MuiTableSortLabel to change the default props of this component with the theme.

CSS classes

These class names are useful for styling with CSS. They are applied to the component's slots when specific states are triggered.

Class name	Rule name	Description
.Mui-active		State class applied to the root element if `active={true}`.
.MuiTableSortLabel-directionAsc	directionAsc	Styles applied to the root element if `direction="asc"`.
.MuiTableSortLabel-directionDesc	directionDesc	Styles applied to the root element if `direction="desc"`.
.MuiTableSortLabel-icon	icon	Styles applied to the icon component.
.MuiTableSortLabel-iconDirectionAsc	iconDirectionAsc	Styles applied to the icon component if `direction="asc"`. Deprecated－Combine the .MuiTableSortLabel-icon and .MuiTableSortLabel-directionAsc classes instead. See Migrating from deprecated APIs for more details.
.MuiTableSortLabel-iconDirectionDesc	iconDirectionDesc	Styles applied to the icon component if `direction="desc"`. Deprecated－Combine the .MuiTableSortLabel-icon and .MuiTableSortLabel-directionDesc classes instead. See Migrating from deprecated APIs for more details.
.MuiTableSortLabel-root	root	Styles applied to the root element.

You can override the style of the component using one of these customization options:

With a global class name.
With a rule name as part of the component's styleOverrides property in a custom theme.

Source code

If you did not find the information in this page, consider having a look at the implementation of the component for more detail.