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';

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

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).

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 using one of these customization options:

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