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:

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

Props of the native component are also available.

Name	Type	Default	Description
children	node	-	Used to render icon or text elements inside the AvatarGroup if `src` is not set. This can be an element, or just a string.
color	'danger' \| 'neutral' \| 'primary' \| 'success' \| 'warning' \| string	'neutral'	The color of the component. It supports those theme colors that make sense for this component. To learn how to add your own colors, check out Themed components—Extend colors.
component	elementType	-	The component used for the root node. Either a string to use a HTML element or a component.
size	'lg' \| 'md' \| 'sm' \| string	'md'	The size of the component. It accepts theme values between 'sm' and 'lg'. To learn how to add custom sizes to the component, check out Themed components—Extend sizes.
slotProps	{ root?: func \| object }	{}	The props used for each slot inside.
slots	{ root?: elementType }	{}	The components used for each slot inside. See Slots API below for more details.
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.
variant	'outlined' \| 'plain' \| 'soft' \| 'solid' \| string	'soft'	The global variant to use. To learn how to add your own variants, check out Themed components—Extend variants.

The ref is forwarded to the root element.

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

To learn how to customize the slot, check out the Overriding component structure guide.

Slot name	Class name	Default component	Description
root	.MuiAvatarGroup-root	`'div'`	The component that renders the root.