@atlaskit/avatar-group
Version:
An avatar group displays a number of avatars grouped together in a stack or grid.
26 lines (25 loc) • 1.06 kB
TypeScript
import React, { type ElementType } from 'react';
import Avatar from '@atlaskit/avatar';
import { type getOverrides } from './get-overrides';
import { type AvatarProps, type onAvatarClickHandler } from './types';
export interface AvatarGroupItemProps {
avatar: AvatarProps;
/**
* Custom component used to render the avatar inside the dropdown menu item.
* When not provided, defaults to the standard Avatar component.
*/
avatarComponent?: typeof Avatar | ElementType<AvatarProps>;
isActive?: boolean;
isHover?: boolean;
avatarOverrides?: ReturnType<typeof getOverrides>['Avatar'];
index: number;
onAvatarClick?: onAvatarClickHandler;
testId?: string;
/**
* Use this to override the accessibility role for the element.
* When used inside a dropdown menu, this should be set to "menuitem".
*/
role?: string;
}
declare const AvatarGroupItem: React.ForwardRefExoticComponent<React.PropsWithoutRef<AvatarGroupItemProps> & React.RefAttributes<HTMLElement>>;
export default AvatarGroupItem;