AvatarGroup API

API documentation for the React AvatarGroup component. Learn about the available props, and the CSS API.

Import

import AvatarGroup from '@material-ui/core/AvatarGroup';
// 或
import { AvatarGroup } from '@material-ui/core';

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

名称	类型	默认值	描述
children	node		The avatars to stack.
classes	object		Override or extend the styles applied to the component. See CSS API below for more details.
max	number	5	Max avatars to show before +x.
spacing	'medium' \| 'small' \| number	'medium'	Spacing between avatars.
sx	object
variant	'circular' \| 'rounded' \| 'square' \| string	'circular'	The variant to use.

ref 则会被传递到根元素中。
Any other props supplied will be provided to the root element (native element).

Rule name	Global class	描述
root	.MuiAvatarGroup-root	Styles applied to the root element.
avatar	.MuiAvatarGroup-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.