Skip to content

TableSortLabel API

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

Component demos

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.

active

If true, the label will have the active styling (should be true for the sorted column).

Type:bool

Default:false

children

Label contents, the arrow will be appended automatically.

Type:node

classes

Override or extend the styles applied to the component.

See CSS API below for more details.

Type:object

direction

The current sort direction.

Type:'asc'
| 'desc'

Default:'asc'

hideSortIcon

Hide sort icon when active is false.

Type:bool

Default:false

IconComponent

Sort icon to use.

Type:elementType

Default:ArrowDownwardIcon

sx

The system prop that allows defining system overrides as well as additional CSS styles.

See the `sx` page for more details.

Type:Array<func
| object
| bool>
| func
| object

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.

.Mui-activeSTATE

State class applied to the root element if active={true}.

.MuiTableSortLabel-icon

Styles applied to the icon component.

Rule name:icon

.MuiTableSortLabel-iconDirectionAsc

Styles applied to the icon component if direction="asc".

Rule name:iconDirectionAsc

.MuiTableSortLabel-iconDirectionDesc

Styles applied to the icon component if direction="desc".

Rule name:iconDirectionDesc

.MuiTableSortLabel-root

Styles applied to the root element.

Rule name:root


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