TableSortLabel API

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

Import

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.

Props

Name	Type	Default	Description
active	bool	false	If `true`, the label will have the active styling (should be true for the sorted column).
children	node		Label contents, the arrow will be appended automatically.
classes	object		Override or extend the styles applied to the component. See CSS API below for more details.
direction	'asc' \| 'desc'	'asc'	The current sort direction.
hideSortIcon	bool	false	Hide sort icon when active is false.
IconComponent	elementType	ArrowDownwardIcon	Sort icon to use.

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

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 name	Global class	Description
root	.MuiTableSortLabel-root	Styles applied to the root element.
active	.MuiTableSortLabel-active	Pseudo-class applied to the root element if `active={true}`.
icon	.MuiTableSortLabel-icon	Styles applied to the icon component.
iconDirectionDesc	.MuiTableSortLabel-iconDirectionDesc	Styles applied to the icon component if `direction="desc"`.
iconDirectionAsc	.MuiTableSortLabel-iconDirectionAsc	Styles applied to the icon component if `direction="asc"`.

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

With a rule name of the classes object prop.
With a global class name.
With a theme and an styleOverrides property.

If that isn't sufficient, you can check the implementation of the component for more detail.

Demos

Tables