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.

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

children

The avatars to stack.

Type:node

classes

Override or extend the styles applied to the component.

See CSS API below for more details.

Type:object

component

The component used for the root node. Either a string to use a HTML element or a component.

Type:elementType

componentsProps

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.

Type:{ additionalAvatar?: object }

Default:{}

max

Max avatars to show before +x.

Type:number

Default:5

renderSurplus

custom renderer of extraAvatars

Type:func

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

Returns: custom element to display

slotProps

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.

Type:{ additionalAvatar?: object }

Default:{}

spacing

Spacing between avatars.

Type:'medium'
| 'small'
| number

Default:'medium'

sx

The system prop that allows defining system overrides as well as additional CSS styles.

See the `sx` page for more details.

Type:Array<func
| object
| bool>
| func
| object

total

The total number of avatars. Used for calculating the number of extra avatars.

Type:number

Default:children.length

variant

The variant to use.

Type:'circular'
| 'rounded'
| 'square'
| string

Default:'circular'

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 classes

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

.MuiAvatarGroup-avatar

Styles applied to the avatar elements.

Rule name:avatar

.MuiAvatarGroup-root

Styles applied to the root element.

Rule name:root


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