Pular para o conteúdo

AvatarGroup API

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

Importação

import AvatarGroup from '@mui/material/AvatarGroup';
// ou
import { AvatarGroup } 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 MuiAvatarGroup can be used when providing default props or style overrides in the theme.

Propriedades

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

NomeTipoPadrãoDescrição
childrennode
The avatars to stack.
classesobject
Sobrescreve ou extende os estilos aplicados para o componente. Veja a API CSS abaixo para maiores detalhes.
componentelementType
componentsProps{ additionalAvatar?: object }{}
The props used for each slot inside the AvatarGroup.
maxnumber5
Max avatars to show before +x.
spacing'medium'
| 'small'
| number
'medium'
Spacing between avatars.
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.
totalnumberchildren.length
The total number of avatars. Used for calculating the number of extra avatars.
variant'circular'
| 'rounded'
| 'square'
| string
'circular'
A variante a usar.

O ref é encaminhado para o elemento raiz.

CSS

Nome da regraClasse globalDescrição
root.MuiAvatarGroup-rootEstilos aplicados ao elemento raiz.
avatar.MuiAvatarGroup-avatarEstilos aplicados a the avatar elements.

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

Demonstrações