Renders an avatar group component with optional extra count.
Parameters:
Name | Type | Attributes | Default | Description |
---|---|---|---|---|
avatars | array | <optional> | Array of avatar component props to render | |
children | React. | <optional> | React element children | |
customAttributes | Record.<string, any> | <optional> | Custom attributes for the component | |
customClasses | string | | <optional> | Custom classes for the component | |
overflowCount | number | <optional> | 0 | Number of avatars to show in overflow count |
showOverflowCount | boolean | <optional> | true | Whether to show the overflow count |
spacing | string | | <optional> | '' | The spacing for the component |
ref | React.RefObject.<HTMLElement> | | 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>
);