@mskcc/carbon-react/lib/components/MskHeader/next/HeaderAvatar.d.ts

Carbon react components for the MSKCC DSM

import React, { FC, HTMLAttributes } from 'react';
export declare const colors: readonly ["blue", "cyan", "green", "magenta", "orange", "purple", "red", "teal", "yellow"];
type AvatarColors = (typeof colors)[number];
export interface HeaderAvatarProps extends HTMLAttributes<HTMLElement> {
    /** Specify a custom className. */
    className?: string;
    /** Specify the label to the right of the avatar */
    children?: React.ReactNode;
    /** Specify the content if no image. */
    label?: string;
    /** Specify a url for the avatar. */
    url?: string;
    /** Specify a icon for the avatar. */
    icon?: string;
    /** Specify a size for the avatar. */
    size?: 'sm' | 'md' | 'lg';
    /** Specify a color for the avatar. */
    color?: AvatarColors;
}
/**
 * @component Avatar component is used to display a user's avatar
 */
export declare const HeaderAvatar: FC<HeaderAvatarProps>;
export {};