Pular para o conteúdo

TableSortLabel API

Documentação da API para o componente React TableSortLabel . Aprenda sobre as propriedades disponíveis e a API CSS.

Importação

import TableSortLabel from '@mui/material/TableSortLabel';
// ou
import { TableSortLabel } from '@mui/material';
Você pode aprender sobre a diferença lendo este guia sobre como minimizar o tamanho do pacote.

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

Nome do componente

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

Propriedades

Propriedades do componente ButtonBase também estão disponíveis.

NomeTipoPadrãoDescrição
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
Sobrescreve ou extende os estilos aplicados para o componente. Veja a API CSS abaixo para maiores detalhes.
direction'asc'
| 'desc'
'asc'
The current sort direction.
hideSortIconboolfalse
Hide sort icon when active is false.
IconComponentelementTypeArrowDownwardIcon
Sort icon to use.
sxArray<func
| 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.

O ref é encaminhado para o elemento raiz.

Herança

Embora não explicitamente documentado acima, as propriedades do componente ButtonBase também estão disponíveis em TableSortLabel. Você pode tirar vantagem disso para manipular componentes aninhados.

CSS

Nome da regraClasse globalDescrição
root.MuiTableSortLabel-rootEstilos aplicados ao elemento raiz.
active.Mui-activePseudo-class aplicada a o elemento raiz se active={true}.
icon.MuiTableSortLabel-iconEstilos aplicados a the icon component.
iconDirectionDesc.MuiTableSortLabel-iconDirectionDescEstilos aplicados para the icon component se direction="desc".
iconDirectionAsc.MuiTableSortLabel-iconDirectionAscEstilos aplicados para the icon component se direction="asc".

Você pode sobrescrever o estilo do componente usando uma dessas opções de customização:

Demonstrações