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

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

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' \| 'info' \| 'neutral' \| 'primary' \| 'success' \| 'warning' \| string	'neutral'	The color of the component. It supports those theme colors that make sense for this component.
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'.
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 variant to use.

The ref is forwarded to the root element.