跳转到内容

AvatarGroup API

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

Import

import AvatarGroup from '@mui/material/AvatarGroup';
// 或
import { AvatarGroup } from '@mui/material';
You can learn about the difference by reading this guide on minimizing bundle size.

Component name

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

属性

Props of the 原生(Native) component are also available.

名称类型默认值描述
childrennode
The avatars to stack.
classesobject
Override or extend the styles applied to the component. See CSS API below for more details.
maxnumber5
Max avatars to show before +x.
spacing'medium'
| 'small'
| number
'medium'
Spacing between avatars.
sxArray<func
| object>
| func
| object
The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.
variant'circular'
| 'rounded'
| 'square'
| string
'circular'
The variant to use.

ref 则会被传递到根元素中。

CSS

Rule nameGlobal class描述
root.MuiAvatarGroup-rootStyles applied to the root element.
avatar.MuiAvatarGroup-avatarStyles applied to the avatar elements.

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

Demos