Skip to content

AvatarGroup API

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

Demos

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.

NameTypeDefaultDescription
childrennode-

The avatars to stack.

classesobject-

Override or extend the styles applied to the component.

See CSS classes API below for more details.

componentelementType-

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.

maxnumber5

Max avatars to show before +x.

renderSurplusfunc-

custom renderer of extraAvatars

Signature:function(surplus: number) => React.ReactNode
  • surplus number of extra avatars

Returns: custom element to display

slotProps{ additionalAvatar?: object, surplus?: func
| object }
{}

The props used for each slot inside.

slots{ surplus?: elementType }{}

The components used for each slot inside.

spacing'medium'
| 'small'
| number
'medium'

Spacing between avatars.

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

totalnumberchildren.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 component cannot hold a ref.

Theme default props

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

Slots

Slot nameClass nameDefault componentDescription
surplus

CSS classes

These class names are useful for styling with CSS. They are applied to the component's slots when specific states are triggered.

Class nameRule nameDescription
.MuiAvatarGroup-avataravatarStyles applied to the avatar elements.
.MuiAvatarGroup-rootrootStyles applied to the root element.

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

Source code

If you did not find the information in this page, consider having a look at the implementation of the component for more detail.