Avatar

The Avatar component is used to represent a user, and displays the profile picture, initials or fallback icon.

Import#

Chakra UI exports 3 avatar-related components:

Avatar: The image that represents the user.
AvatarBadge: A wrapper that displays its content on the right corner of the avatar.
AvatarGroup: A wrapper to stack multiple Avatars together.

import { Avatar, AvatarBadge } from "@chakra-ui/react"

import { Avatar, AvatarBadge } from "@chakra-ui/react"

Usage#

<Wrap>
  <WrapItem>
    <Avatar name="Dan Abrahmov" src="https://bit.ly/dan-abramov" />
  </WrapItem>
  <WrapItem>
    <Avatar name="Kola Tioluwani" src="https://bit.ly/tioluwani-kolawole" />
  </WrapItem>
  <WrapItem>
    <Avatar name="Kent Dodds" src="https://bit.ly/kent-c-dodds" />
  </WrapItem>
  <WrapItem>
    <Avatar name="Ryan Florence" src="https://bit.ly/ryan-florence" />
  </WrapItem>
  <WrapItem>
    <Avatar name="Prosper Otemuyiwa" src="https://bit.ly/prosper-baba" />
  </WrapItem>
  <WrapItem>
    <Avatar name="Christian Nwamba" src="https://bit.ly/code-beast" />
  </WrapItem>
  <WrapItem>
    <Avatar name="Segun Adebayo" src="https://bit.ly/sage-adebayo" />
  </WrapItem>
</Wrap>

<Wrap>
  <WrapItem>
    <Avatar name="Dan Abrahmov" src="https://bit.ly/dan-abramov" />
  </WrapItem>
  <WrapItem>
    <Avatar name="Kola Tioluwani" src="https://bit.ly/tioluwani-kolawole" />
  </WrapItem>
  <WrapItem>
    <Avatar name="Kent Dodds" src="https://bit.ly/kent-c-dodds" />
  </WrapItem>
  <WrapItem>
    <Avatar name="Ryan Florence" src="https://bit.ly/ryan-florence" />
  </WrapItem>
  <WrapItem>
    <Avatar name="Prosper Otemuyiwa" src="https://bit.ly/prosper-baba" />
  </WrapItem>
  <WrapItem>
    <Avatar name="Christian Nwamba" src="https://bit.ly/code-beast" />
  </WrapItem>
  <WrapItem>
    <Avatar name="Segun Adebayo" src="https://bit.ly/sage-adebayo" />
  </WrapItem>
</Wrap>

Editable Example

Avatar Sizes#

The Avatar component comes in 7 sizes.

<Wrap>
  <WrapItem>
    <Avatar size="2xs" name="Dan Abrahmov" src="https://bit.ly/dan-abramov" />
  </WrapItem>
  <WrapItem>
    <Avatar
      size="xs"
      name="Kola Tioluwani"
      src="https://bit.ly/tioluwani-kolawole"
    />{" "}
  </WrapItem>
  <WrapItem>
    <Avatar size="sm" name="Kent Dodds" src="https://bit.ly/kent-c-dodds" />{" "}
  </WrapItem>
  <WrapItem>
    <Avatar size="md" name="Ryan Florence" src="https://bit.ly/ryan-florence" />{" "}
  </WrapItem>
  <WrapItem>
    <Avatar
      size="lg"
      name="Prosper Otemuyiwa"
      src="https://bit.ly/prosper-baba"
    />{" "}
  </WrapItem>
  <WrapItem>
    <Avatar size="xl" name="Christian Nwamba" src="https://bit.ly/code-beast" />{" "}
  </WrapItem>
  <WrapItem>
    <Avatar size="2xl" name="Segun Adebayo" src="https://bit.ly/sage-adebayo" />{" "}
  </WrapItem>
</Wrap>

<Wrap>
  <WrapItem>
    <Avatar size="2xs" name="Dan Abrahmov" src="https://bit.ly/dan-abramov" />
  </WrapItem>
  <WrapItem>
    <Avatar
      size="xs"
      name="Kola Tioluwani"
      src="https://bit.ly/tioluwani-kolawole"
    />{" "}
  </WrapItem>
  <WrapItem>
    <Avatar size="sm" name="Kent Dodds" src="https://bit.ly/kent-c-dodds" />{" "}
  </WrapItem>
  <WrapItem>
    <Avatar size="md" name="Ryan Florence" src="https://bit.ly/ryan-florence" />{" "}
  </WrapItem>
  <WrapItem>
    <Avatar
      size="lg"
      name="Prosper Otemuyiwa"
      src="https://bit.ly/prosper-baba"
    />{" "}
  </WrapItem>
  <WrapItem>
    <Avatar size="xl" name="Christian Nwamba" src="https://bit.ly/code-beast" />{" "}
  </WrapItem>
  <WrapItem>
    <Avatar size="2xl" name="Segun Adebayo" src="https://bit.ly/sage-adebayo" />{" "}
  </WrapItem>
</Wrap>

Editable Example

Avatar Fallbacks#

If there is an error loading the src of the avatar, there are 2 fallbacks:

If there's a name prop, we use it to generate the initials and a random, accessible background color.
If there's no name prop, we use a default avatar.

<Stack direction="row">
  <Avatar name="Oshigaki Kisame" src="https://bit.ly/broken-link" />
  <Avatar name="Sasuke Uchiha" src="https://bit.ly/broken-link" />
  <Avatar src="https://bit.ly/broken-link" />
</Stack>

<Stack direction="row">
  <Avatar name="Oshigaki Kisame" src="https://bit.ly/broken-link" />
  <Avatar name="Sasuke Uchiha" src="https://bit.ly/broken-link" />
  <Avatar src="https://bit.ly/broken-link" />
</Stack>

Editable Example

Customize the fallback avatar#

You can customize the background color and icon of the fallback avatar icon to match your design requirements.

To update the background, pass the usual bg prop.
To update the icon svg, pass the icon prop.

<AvatarGroup spacing="1rem">
  <Avatar bg="red.500" icon={<AiOutlineUser fontSize="1.5rem" />} />
  <Avatar bg="teal.500" />
</AvatarGroup>

<AvatarGroup spacing="1rem">
  <Avatar bg="red.500" icon={<AiOutlineUser fontSize="1.5rem" />} />
  <Avatar bg="teal.500" />
</AvatarGroup>

Editable Example

Avatar with badge#

In some products, you might need to show a badge on the right corner of the avatar. We call this a badge. Here's an example that shows if the user is online:

<Stack direction="row" spacing={4}>
  <Avatar>
    <AvatarBadge boxSize="1.25em" bg="green.500" />
  </Avatar>

  {/* You can also change the borderColor and bg of the badge */}
  <Avatar>
    <AvatarBadge borderColor="papayawhip" bg="tomato" boxSize="1.25em" />
  </Avatar>
</Stack>

<Stack direction="row" spacing={4}>
  <Avatar>
    <AvatarBadge boxSize="1.25em" bg="green.500" />
  </Avatar>
  {/* You can also change the borderColor and bg of the badge */}
  <Avatar>
    <AvatarBadge borderColor="papayawhip" bg="tomato" boxSize="1.25em" />
  </Avatar>
</Stack>

Editable Example

Note the use of em for the size of the AvatarBadge. This is useful to size the badge relative to the avatar font size.

AvatarGroup#

In some cases, you might need to stack avatars as a group. Use the AvatarGroup component.

To limit the amount of avatars to show, use the max prop. It'll truncate the avatars and show a "+X" label (where X is the remaining avatars).
To size all the avatars equally, pass the size prop.
To adjust the spacing between the avatars, pass the spacing prop.

<AvatarGroup size="md" max={2}>
  <Avatar name="Ryan Florence" src="https://bit.ly/ryan-florence" />
  <Avatar name="Segun Adebayo" src="https://bit.ly/sage-adebayo" />
  <Avatar name="Kent Dodds" src="https://bit.ly/kent-c-dodds" />
  <Avatar name="Prosper Otemuyiwa" src="https://bit.ly/prosper-baba" />
  <Avatar name="Christian Nwamba" src="https://bit.ly/code-beast" />
</AvatarGroup>

<AvatarGroup size="md" max={2}>
  <Avatar name="Ryan Florence" src="https://bit.ly/ryan-florence" />
  <Avatar name="Segun Adebayo" src="https://bit.ly/sage-adebayo" />
  <Avatar name="Kent Dodds" src="https://bit.ly/kent-c-dodds" />
  <Avatar name="Prosper Otemuyiwa" src="https://bit.ly/prosper-baba" />
  <Avatar name="Christian Nwamba" src="https://bit.ly/code-beast" />
</AvatarGroup>

Editable Example

Changing the initials logic#

Added getInitials prop to allow users to manage how initials are generated from name. By default we merge the first characters of each word in the name prop.

Props#

The Avatar component composes Box component so you can pass props for Box.

Name	Type	Description	Default
colorScheme	`string`		-
getInitials	`((name: string) => string)`	Function to get the initials to display	-
icon	`React.ReactElement`	The default avatar used as fallback when `name`, and `src` is not specified.	-
loading	`"eager" \| "lazy"`	Defines loading strategy	-
name	`string`	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	-
onError	`(() => void)`	Function called when image failed to load	-
orientation	`"horizontal" \| "vertical"`		-
showBorder	`boolean`	If `true`, the `Avatar` will show a border around it. Best for a group of avatars	-
size	`string`	The size of the avatar.	-
src	`string`	The image url of the `Avatar`	-
srcSet	`string`	List of sources to use for different screen resolutions	-
styleConfig	`Record<string, any>`		-
variant	`string`		-

Edit this page

Avatar

.css-12m0k8p{pointer-events:auto;}Import.css-1l2j62r{color:#319795;font-weight:400;outline:none;opacity:0;margin-left:0.375rem;}.css-1l2j62r:focus,.css-1l2j62r[data-focus]{opacity:1;box-shadow:0 0 0 3px rgba(66, 153, 225, 0.6);}#

Usage#

Avatar Sizes#

Avatar Fallbacks#

Customize the fallback avatar#

Avatar with badge#

AvatarGroup#

Changing the initials logic#

Props#

Import#