@chakra-ui/core/dist/Avatar/index.d.ts

Responsive and accessible React UI components built with React and Emotion

import * as React from "react";
import { BoxProps } from "../Box";
import { Omit } from "../common-types";

type Size = "2xs" | "xs" | "sm" | "md" | "lg" | "xl" | "2xl";

export interface IAvatar {
  /**
   * The name of the person in the avatar.
   *
   * - if `src` has loaded, the name will be used as the `alt` attribute of the `img`
   * - If `src` is not loaded, the name will be used to create the initials
   */
  name?: string;
  /**
   * The size of the avatar.
   */
  size?: Size;
  /**
   * If `true`, the `Avatar` will show a border around it.
   *
   * Best for a group of avatars
   */
  showBorder?: boolean;
  /**
   * The badge at the bottom right corner of the avatar.
   */
  children?: React.ReactNode;
  /**
   * The image url of the `Avatar`
   */
  src?: string;
}

export type AvatarNameProps = IAvatar["name"] & BoxProps;
export const AvatarName: React.FC<AvatarNameProps>;

export const AvatarBadge: React.FC<BoxProps>;

export type AvatarProps = IAvatar & Omit<BoxProps, "size">;
/**
 * The Avatar component is used to represent user, and displays the profile
 * picture, initials or fallback icon.
 */
declare const Avatar: React.FC<AvatarProps>;

export default Avatar;