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.

Nome	Tipo	Padrão	Descrição
alignItems	'center' \| 'flex-start'	'center'	Defines the `align-items` style property.
autoFocus	bool	false	If `true`, the list item is focused during the first mount. Focus will also be triggered if the value changes from false to true.
children	node		The content of the component if a `ListItemSecondaryAction` is used it must be the last child.
classes	object		Sobrescreve ou extende os estilos aplicados para o componente. Veja a API CSS abaixo para maiores detalhes.
component	elementType		The component used for the root node. Either a string to use a HTML element or a component.
dense	bool	false	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.
disabled	bool	false	Se `true`, o componente está desabilitado.
disableGutters	bool	false	If `true`, the left and right padding is removed.
divider	bool	false	If `true`, a 1px light border is added to the bottom of the list item.
focusVisibleClassName	string		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.
selected	bool	false	Use to apply selected styling.
sx	Array<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 regra	Classe global	Descrição
root	.MuiListItemButton-root	Estilos aplicados ao elemento raiz.
focusVisible	.Mui-focusVisible	Pseudo-class applied to the `component`'s `focusVisibleClassName` prop.
dense	.MuiListItemButton-dense	Estilos aplicados para the component element se dense.
alignItemsFlexStart	.MuiListItemButton-alignItemsFlexStart	Estilos aplicados para the component element se `alignItems="flex-start"`.
disabled	.Mui-disabled	Pseudo-class aplicada a the inner `component` element se `disabled={true}`.
divider	.MuiListItemButton-divider	Estilos aplicados para the inner `component` element se `divider={true}`.
gutters	.MuiListItemButton-gutters	Estilos aplicados em the inner `component` element a menos que `disableGutters={true}`.
selected	.Mui-selected	Pseudo-class aplicada a o elemento raiz se `selected={true}`.

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

Com um nome de classe global.
Com um nome de regra como parte da propriedade styleOverrides do componente em um tema personalizado.

Demonstrações

Lists