Skip to content

TableSortLabel API

API documentation for the React TableSortLabel component. Learn about the available props and the CSS API.

Import

import TableSortLabel from '@mui/material/TableSortLabel';
// or
import { TableSortLabel } from '@mui/material';
You can learn about the difference by reading this guide on minimizing bundle size.

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

Component name

The name MuiTableSortLabel can be used when providing default props or style overrides in the theme.

Props

Props of the ButtonBase component are also available.

NameTypeDefaultDescription
activeboolfalse
If true, the label will have the active styling (should be true for the sorted column).
childrennode
Label contents, the arrow will be appended automatically.
classesobject
Override or extend the styles applied to the component. See CSS API below for more details.
direction'asc'
| 'desc'
'asc'
The current sort direction.
hideSortIconboolfalse
Hide sort icon when active is false.
IconComponentelementTypeArrowDownwardIcon
Sort icon to use.
sxobject
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 on TableSortLabel. You can take advantage of this to target nested components.

CSS

Rule nameGlobal classDescription
root.MuiTableSortLabel-rootStyles applied to the root element.
active.MuiTableSortLabel-activeState class applied to the root element if active={true}.
icon.MuiTableSortLabel-iconStyles applied to the icon component.
iconDirectionDesc.MuiTableSortLabel-iconDirectionDescStyles applied to the icon component if direction="desc".
iconDirectionAsc.MuiTableSortLabel-iconDirectionAscStyles applied to the icon component if direction="asc".

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

Demos