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.


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


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.


Props of the ButtonBase component are also available.

If true, the label will have the active styling (should be true for the sorted column).
Label contents, the arrow will be appended automatically.
Override or extend the styles applied to the component. See CSS API below for more details.
| 'desc'
The current sort direction.
Hide sort icon when active is false.
Sort icon to use.
| 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.


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.

Theme default props

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


Rule nameGlobal classDescription
root.MuiTableSortLabel-rootStyles applied to the root element.
active.Mui-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: