UNPKG

699 BTypeScriptView Raw
1import * as React from 'react';
2import { StandardProps } from '@material-ui/core';
3
4export interface AvatarGroupProps
5 extends StandardProps<React.HTMLAttributes<HTMLDivElement>, AvatarGroupClassKey> {
6 /**
7 * The avatars to stack.
8 */
9 children?: React.ReactNode;
10 /**
11 * Max avatars to show before +x.
12 */
13 max?: number;
14 /**
15 * Spacing between avatars.
16 */
17 spacing?: 'small' | 'medium' | number;
18}
19
20export type AvatarGroupClassKey = 'root' | 'avatar';
21
22/**
23 *
24 * Demos:
25 *
26 * - [Avatars](https://mui.com/components/avatars/)
27 *
28 * API:
29 *
30 * - [AvatarGroup API](https://mui.com/api/avatar-group/)
31 */
32export default function AvatarGroup(props: AvatarGroupProps): JSX.Element;