Pular para o conteúdo

ListItemButton API

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

Importação

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

Nome do componente

The name MuiListItemButton 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
alignItems'center'
| 'flex-start'
'center'
Defines the align-items style property.
autoFocusboolfalse
If true, the list item is focused during the first mount. Focus will also be triggered if the value changes from false to true.
childrennode
The content of the component if a ListItemSecondaryAction is used it must be the last child.
classesobject
Sobrescreve ou extende os estilos aplicados para o componente. Veja a API CSS abaixo para maiores detalhes.
componentelementType
The component used for the root node. Either a string to use a HTML element or a component.
denseboolfalse
If true, compact vertical padding designed for keyboard and mouse input is used. The prop defaults to the value inherited from the parent List component.
disabledboolfalse
Se true, o componente está desabilitado.
disableGuttersboolfalse
If true, the left and right padding is removed.
dividerboolfalse
If true, a 1px light border is added to the bottom of the list item.
focusVisibleClassNamestring
This prop can help identify which element has keyboard focus. The class name will be applied when the element gains the focus through keyboard interaction. It's a polyfill for the CSS :focus-visible selector. The rationale for using this feature is explained here. A polyfill can be used to apply a focus-visible class to other components if needed.
selectedboolfalse
Use to apply selected styling.
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 ListItemButton. Você pode tirar vantagem disso para manipular componentes aninhados.

CSS

Nome da regraClasse globalDescrição
root.MuiListItemButton-rootEstilos aplicados ao elemento raiz.
focusVisible.Mui-focusVisiblePseudo-class applied to the `component`'s `focusVisibleClassName` prop.
dense.MuiListItemButton-denseEstilos aplicados para the component element se dense.
alignItemsFlexStart.MuiListItemButton-alignItemsFlexStartEstilos aplicados para the component element se alignItems="flex-start".
disabled.Mui-disabledPseudo-class aplicada a the inner `component` element se disabled={true}.
divider.MuiListItemButton-dividerEstilos aplicados para the inner `component` element se divider={true}.
gutters.MuiListItemButton-guttersEstilos aplicados em the inner `component` element a menos que disableGutters={true}.
selected.Mui-selectedPseudo-class aplicada a o elemento raiz se selected={true}.

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

Demonstrações