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

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

Component name

The MuiAvatarGroup name can be used for providing default props or style overrides at the theme level.

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.
variant	'circular' | 'rounded' | 'square' | string	'circular'	The shape of the avatars.

The ref is forwarded to the root element.

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

CSS

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:

• With a rule name of the classes object prop.
• With a global class name.
• With a theme and an overrides property.

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

Demos

• Avatars