#Avatar

The <Avatar> component renders a 60x60 pixel image by default.

#Import

import { Avatar } from 'bumbag';

#Usage

<Avatar src="/bean.jpg" alt="Photo of Mr. Bean" />

<Avatar src="/bean.jpg" alt="Photo of Mr. Bean" />

#Shapes

Avatars are available in two different shapes and can be changed using the variant prop.

<Avatar variant="circle" src="/bean.jpg" alt="Photo of Mr. Bean" />

<Avatar variant="circle" src="/bean.jpg" alt="Photo of Mr. Bean" />

#Sizes

Avatars are available in five different sizes or you can set your own using the size prop.

<Set>
  <Avatar variant="circle" src="/bean.jpg" alt="Photo of Mr. Bean" size="small" />
  <Avatar variant="circle" src="/bean.jpg" alt="Photo of Mr. Bean" />
  <Avatar variant="circle" src="/bean.jpg" alt="Photo of Mr. Bean" size="medium" />
  <Avatar variant="circle" src="/bean.jpg" alt="Photo of Mr. Bean" size="large" />
  <Avatar variant="circle" src="/bean.jpg" alt="Photo of Mr. Bean" size="150px" />
</Set>

<Set>
  <Avatar variant="circle" src="/bean.jpg" alt="Photo of Mr. Bean" size="small" />
  <Avatar variant="circle" src="/bean.jpg" alt="Photo of Mr. Bean" />
  <Avatar variant="circle" src="/bean.jpg" alt="Photo of Mr. Bean" size="medium" />
  <Avatar variant="circle" src="/bean.jpg" alt="Photo of Mr. Bean" size="large" />
  <Avatar variant="circle" src="/bean.jpg" alt="Photo of Mr. Bean" size="150px" />
</Set>

#Initials

Avatars can also be initials using the initials prop.

<Set>
  <Avatar initials="JM" variant="circle" palette="primary" size="small" />
  <Avatar initials="Jake Moxey" variant="circle" palette="secondary" />
  <Avatar initials="JM" variant="circle" palette="success" size="medium" />
  <Avatar initials="JM" variant="circle" palette="warning" size="large" />
</Set>

<Set>
  <Avatar initials="JM" variant="circle" palette="primary" size="small" />
  <Avatar initials="Jake Moxey" variant="circle" palette="secondary" />
  <Avatar initials="JM" variant="circle" palette="success" size="medium" />
  <Avatar initials="JM" variant="circle" palette="warning" size="large" />
</Set>

#Accessibility

#Rules

If the avatar is an image, it must have an alt prop.

#Props

#Avatar Props

variant (string & {}) | "circle"

Variant of the avatar.

src string

URL of the avatar image.

size string | (string & {})

Size of the avatar.

initials string

Initials to place on the avatar.

palette

"default"
  | "primary"
  | "secondary"
  | "success"
  | "danger"
  | "warning"
  | (string & {})

Color of the avatar.

#Theming

Avatar.styles.base

Avatar.styles.sizes.small

Avatar.styles.sizes.default

Avatar.styles.sizes.medium

Avatar.styles.sizes.large