Skip to content
Edit this page

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:

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

The following class names are useful for styling with CSS (the state classes are marked).
To learn more, visit the component customization page.


.MuiTableSortLabel-rootroot

Styles applied to the root element.

.Mui-activeactiveSTATE

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

.MuiTableSortLabel-iconicon

Styles applied to the icon component.

.MuiTableSortLabel-iconDirectionDesciconDirectionDesc

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

.MuiTableSortLabel-iconDirectionAsciconDirectionAsc

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

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