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 '@material-ui/core/AvatarGroup';
// or
import { AvatarGroup } from '@material-ui/core';
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

NameTypeDefaultDescription
childrennodeThe avatars to stack.
classesobjectOverride or extend the styles applied to the component. See CSS API below for more details.
maxnumber5Max avatars to show before +x.
spacing'medium'
| 'small'
| number
'medium'Spacing between avatars.
variant'circular'
| 'rounded'
| 'square'
| string
'circular'The variant to use.

The ref is forwarded to the root element.
Any other props supplied will be provided to the root element (native 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: If that isn't sufficient, you can check the implementation of the component for more detail.

Demos