Renders an avatar group component with optional extra count.

Parameters:
NameTypeAttributesDefaultDescription
avatarsarray<optional>

Array of avatar component props to render

childrenReact.ReactNode | Array.<React.ReactNode><optional>

React element children

customAttributesRecord.<string, any><optional>

Custom attributes for the component

customClassesstring | Array.<string> | Record.<string, boolean><optional>

Custom classes for the component

overflowCountnumber<optional>
0

Number of avatars to show in overflow count

showOverflowCountboolean<optional>
true

Whether to show the overflow count

spacingstring | number | Array.<string> | Record.<string, any><optional>
''

The spacing for the component

refReact.RefObject.<HTMLElement> | null

Ref to the component

Since
  • 5.4.6
Returns:

The avatar component.

Type: 
JSX.Element
Example
import AvatarGroup from '@gravityforms/components/react/admin/modules/AvatarGroup';

return (
    <AvatarGroup>
        { 'children' }
    </AvatarGroup>
);