@activecollab/components
Version:
ActiveCollab Components
43 lines • 1.47 kB
TypeScript
import React, { PropsWithChildren } from "react";
export interface MultiAvatarProps {
/** Path url. */
url: string[];
/** Alt text. */
alt?: string[];
/** Image size. */
size?: number;
/** Custom class. */
className?: string;
}
/**
* @component MultiAvatar
* @description
* The MultiAvatar component is used to represent user, and displays the profile picture, initials or fallback icon.
*
* @prop {url} - The image urls of the MultiAvatar.
* @prop {size} - controls the size of an MultiAvatar (width and height) in pixels.
* @prop {alt} - alt attributes of the imgs.
*
* @example
* <MultiAvatar
* url={["https://faces-img.xcdn.link/image-lorem-face-954.jpg", "https://faces-img.xcdn.link/image-lorem-face-953.jpg"]}
* alt={["Profile picture of John", "Profile picture of Sarah"]} />
*
* @example
* <MultiAvatar
* url={["https://faces-img.xcdn.link/image-lorem-face-954.jpg", "https://faces-img.xcdn.link/image-lorem-face-953.jpg"]}
* alt={["Profile picture of John", "Profile picture of Sarah"]}
* >
* <Badge />
* </MultiAvatar>
*
* @see
* https://system.activecollab.com/?path=/story/components-button-indicators-avatar--avatar
* @see
* https://design.activecollab.com/docs/components/avatar
*/
export declare const MultiAvatar: {
({ url, alt, size, className, children, }: PropsWithChildren<MultiAvatarProps>): React.JSX.Element;
displayName: string;
};
//# sourceMappingURL=MultiAvatar.d.ts.map