Skip to content

AvatarGroup API

The API documentation of the AvatarGroup React component. Learn more about the props and the CSS customization points.

Import

import AvatarGroup from '@material-ui/lab/AvatarGroup';
// or
import { AvatarGroup } from '@material-ui/lab';

You can learn more about the difference by reading this guide.

Props

Name Type Default Description
children node The avatars to stack.
classes object Override or extend the styles applied to the component. See CSS API below for more details.
max number 5 Max avatars to show before +x.
spacing 'medium'
| 'small'
| number
'medium' Spacing between avatars.

The ref is forwarded to the root element.

Any other props supplied will be provided to the root element (native element).

CSS

  • Style sheet name: MuiAvatarGroup.
  • Style sheet details:
Rule name Global class Description
root .MuiAvatarGroup-root Styles applied to the root element.
avatar .MuiAvatarGroup-avatar Styles applied to the avatar elements.

You can override the style of the component thanks to one of these customization points:

If that's not sufficient, you can check the implementation of the component for more detail.

Demos