跳转到内容

AvatarGroup API

想要学习更多组件属性和 CSS API,可以查阅 React AvatarGroup 组件的 API 文档。

导入

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.

组件名称

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

属性

原生(Native) 组件的属性也是可用的。

名称类型默认值描述
childrennode
The avatars to stack.
classesobject
Override or extend the styles applied to the component. See CSS API below for more details.
componentsProps{ additionalAvatar?: object }{}
The props used for each slot inside the AvatarGroup.
maxnumber5
Max avatars to show before +x.
spacing'medium'
| 'small'
| number
'medium'
Spacing between avatars.
sxArray<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.
totalnumberchildren.length
The total number of avatars. Used for calculating the number of extra avatars.
variant'circular'
| 'rounded'
| 'square'
| string
'circular'
The variant to use.

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

CSS

规则名称全局类名描述
root.MuiAvatarGroup-rootStyles applied to the root element.
avatar.MuiAvatarGroup-avatarStyles applied to the avatar elements.

您可以使用组件自定义选项对组件进行个性化:

演示项目