AvatarGroup API

API reference docs for the React AvatarGroup component. Learn about the props, CSS, and other APIs of this exported module.

Demos

For examples and details on the usage of this React component, visit the component demo pages:

Avatar

Import

import AvatarGroup from '@mui/material/AvatarGroup';
// or
import { AvatarGroup } from '@mui/material';

Learn about the difference by reading this guide on minimizing bundle size.

Props

Props of the native component are also available.

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.
component	elementType		The component used for the root node. Either a string to use a HTML element or a component.
componentsProps	{ additionalAvatar?: object }	{}	The extra props for the slot components. You can override the existing props or add new ones. This prop is an alias for the `slotProps` prop. It's recommended to use the `slotProps` prop instead, as `componentsProps` will be deprecated in the future.
max	number	5	Max avatars to show before +x.
renderSurplus	func		custom renderer of extraAvatars Signature:`function(surplus: number) => React.ReactNode` `surplus` number of extra avatars Returns: custom element to display
slotProps	{ additionalAvatar?: object }	{}	The extra props for the slot components. You can override the existing props or add new ones. This prop is an alias for the `componentsProps` prop, which will be deprecated in the future.
spacing	'medium' \| 'small' \| number	'medium'	Spacing between avatars.
sx	Array<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.
total	number	children.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.

Theme default props

You can use MuiAvatarGroup to change the default props of this component with the theme.

CSS

The following class names are useful for styling with CSS (the state classes are marked).
To learn more, visit the component customization page.

Global class	Rule name	Description
.MuiAvatarGroup-root	root	Styles applied to the root element.
.MuiAvatarGroup-avatar	avatar	Styles applied to the avatar elements.

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

With a global class name.
With a rule name as part of the component's styleOverrides property in a custom theme.

Have any feedback about this new API display design?

We've heard from you and iterated on making the design of API content documentation more scalable and easier to parse! We value your input, so please don't hesitate to share any additional feedback you may have.