@shopify/polaris
Version:
Shopify’s admin product component library
31 lines (30 loc) • 1.02 kB
TypeScript
declare type Size = 'extraSmall' | 'small' | 'medium' | 'large';
declare type Shape = 'square' | 'round';
export declare const STYLE_CLASSES: string[];
export interface AvatarProps {
/**
* Size of avatar
* @default 'medium'
*/
size?: Size;
/**
* Shape of avatar
* @default 'round'
*/
shape?: Shape;
/** The name of the person */
name?: string;
/** Initials of person to display */
initials?: string;
/** Whether the avatar is for a customer */
customer?: boolean;
/** URL of the avatar image which falls back to initials if the image fails to load */
source?: string;
/** Callback fired when the image fails to load */
onError?(): void;
/** Accessible label for the avatar image */
accessibilityLabel?: string;
}
export declare function Avatar({ name, source, onError, initials, customer, size, shape, accessibilityLabel, }: AvatarProps): JSX.Element;
export {};
//# sourceMappingURL=Avatar.d.ts.map