Skip to content

TableSortLabel API

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


import TableSortLabel from '@material-ui/core/TableSortLabel';
// or
import { TableSortLabel } from '@material-ui/core';
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.


activeboolfalseIf true, the label will have the active styling (should be true for the sorted column).
childrennodeLabel contents, the arrow will be appended automatically.
classesobjectOverride or extend the styles applied to the component. See CSS API below for more details.
| 'desc'
'asc'The current sort direction.
hideSortIconboolfalseHide sort icon when active is false.
IconComponentelementTypeArrowDownwardIconSort icon to use.

The ref is forwarded to the root element.
Any other props supplied will be provided to the root element (ButtonBase).


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.


Rule nameGlobal classDescription
root.MuiTableSortLabel-rootStyles applied to the root element.
active.MuiTableSortLabel-activePseudo-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: If that isn't sufficient, you can check the implementation of the component for more detail.