Skip to content

AvatarGroup API

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

Import

import AvatarGroup from '@mui/material/AvatarGroup';
// or
import { AvatarGroup } from '@mui/material';
You can learn about the difference by reading this guide on minimizing bundle size.

Component name

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

Props

Props of the native component are also available.

NameTypeDefaultDescription
childrennode
The avatars to stack.
classesobject
Override or extend the styles applied to the component. See CSS API below for more details.
componentelementType
The component used for the root node. Either a string to use a HTML element or a component.
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'
The variant to use.

The ref is forwarded to the root element.

CSS

Rule nameGlobal classDescription
root.MuiAvatarGroup-rootStyles applied to the root element.
avatar.MuiAvatarGroup-avatarStyles applied to the avatar elements.

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

Demos