Avatar

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

Props#

Avatar Props#

Avatar composes the Box component so you can pass all its props. These are props specific to the Avatar component:

`colorScheme`

Description

The visual color appearance of the component

Type

"whiteAlpha" | "blackAlpha" | "gray" | "red" | "orange" | "yellow" | "green" | "teal" | "blue" | "cyan" | "purple" | "pink"

`crossOrigin`

Type

"" | "anonymous" | "use-credentials"

`getInitials`

Description

Function to get the initials to display

Type

(name: string) => string

`icon`

Description

The default avatar used as fallback when name, and src is not specified.

Type

ReactElement<any, string | JSXElementConstructor<any>>

`iconLabel`

Type

string

`ignoreFallback`

Description

If true, opt out of the avatar's fallback logic and renders the img at all times.

Type

boolean

Default

false

`loading`

Description

Defines loading strategy

Type

"eager" | "lazy"

`name`

Description

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

Type

string

`onError`

Description

Function called when image failed to load

Type

() => void

`referrerPolicy`

Description

Defining which referrer is sent when fetching the resource.

Type

HTMLAttributeReferrerPolicy

`showBorder`

Description

If true, the Avatar will show a border around it. Best for a group of avatars

Type

boolean

Default

false

`size`

Description

The size of the Avatar

Type

"2xs" | "xs" | "sm" | "md" | "lg" | "xl" | "2xl" | "full"

Default

md

`src`

Description

The image url of the Avatar

Type

string

`srcSet`

Description

List of sources to use for different screen resolutions

Type

string

`variant`

Description

The variant of the Avatar

Type

string

Avatar Group Props#

AvatarGroup composes the Box component so you can pass all its props. These are props specific to the AvatarGroup component:

`max`

Description

The maximum number of visible avatars

Type

number

`spacing`

Description

The space between the avatars in the group.

Type

ResponsiveValue<string | number | (string & {})>

Default

-0.75rem

The Avatar component is a multipart component. The styling needs to be applied to each part specifically.

To learn more about styling multipart components, visit the Component Style page.

Anatomy#

A: badge
B: container
C: excessLabel
D: group

Theming properties#

The properties that affect the theming of the Avatar component are:

size: The size of the button. Defaults to md.

Theming utilities#

createMultiStyleConfigHelpers: a function that returns a set of utilities for creating style configs for a multipart component (definePartsStyle and defineMultiStyleConfig).
definePartsStyle: a function used to create multipart style objects.
defineMultiStyleConfig: a function used to define the style configuration for a multipart component.

import { avatarAnatomy } from '@chakra-ui/anatomy'
import { createMultiStyleConfigHelpers } from '@chakra-ui/react'

const { definePartsStyle, defineMultiStyleConfig } =
  createMultiStyleConfigHelpers(avatarAnatomy.keys)

Customizing the default theme#

import { avatarAnatomy } from '@chakra-ui/anatomy'
import { createMultiStyleConfigHelpers } from '@chakra-ui/react'

const { definePartsStyle, defineMultiStyleConfig } =
  createMultiStyleConfigHelpers(avatarAnatomy.keys)

const baseStyle = definePartsStyle({
  // define the part you're going to style
  badge: {
    bg: 'gray.500',
    border: '2px solid',
  },
  container: {
    borderRadius: 'xl',
  },
  excessLabel: {
    bg: 'gray.800',
    color: 'white',
    borderRadius: 'xl',
  },
})

export const avatarTheme = defineMultiStyleConfig({ baseStyle })

After customizing the avatar theme, we can import it in our theme file and add it in the components property:

import { extendTheme } from '@chakra-ui/react'
import { avatarTheme } from './components/avatar'

export const theme = extendTheme({
  components: { Avatar: avatarTheme },
})

This is a crucial step to make sure that any changes that we make to the avatar theme are applied.

Adding a custom size#

Let's assume we want to include an super large avatar size. Here's how we can do that:

import { avatarAnatomy } from '@chakra-ui/anatomy'
import { createMultiStyleConfigHelpers, defineStyle } from '@chakra-ui/react'

const { definePartsStyle, defineMultiStyleConfig } =
  createMultiStyleConfigHelpers(avatarAnatomy.keys)

const superLg = defineStyle({
  width: 40,
  height: 40,
  fontSize: "6xl"
})

const sizes = {
  superLg: definePartsStyle({ container: superLg }),
}

export const avatarTheme = defineMultiStyleConfig({ sizes })

// Now we can use the new `superLg` size
<Avatar size="superLg" ... />
// or
<AvatarGroup size="superLg">...</AvatarGroup>

Every time you're adding anything new to the theme, you'd need to run the CLI command to get proper autocomplete in your IDE. You can learn more about the CLI tool here.

Adding a custom variant#

Let's assume we want to include a custom rounded square variant. Here's how we can do that:

import { avatarAnatomy } from '@chakra-ui/anatomy'
import { createMultiStyleConfigHelpers, defineStyle } from '@chakra-ui/react'

const { definePartsStyle, defineMultiStyleConfig } =
  createMultiStyleConfigHelpers(avatarAnatomy.keys)

const roundedSquare = definePartsStyle({
  badge: {
    bg: "gray.500",
    border: "2px solid"
  },
  container: {
    borderRadius: "xl"
  },
  excessLabel: {
    bg: "gray.800",
    color: "white",
    borderRadius: "xl",
    border: "2px solid",

    // let's also provide dark mode alternatives
    _dark: {
      bg: "gray.400",
      color: "gray.900"
    }
  }
})

export const avatarTheme = defineMultiStyleConfig({
  variants: { roundedSquare },
})

// Now we can use the new `roundedSquare` variant
<Avatar variant="roundedSquare" ... />
// or
<AvatarGroup variant="roundedSquare">...</AvatarGroup>

Changing the default properties#

Let's assume we want to change the default size and variant of every avatar in our app. Here's how we can do that:

import { avatarAnatomy } from '@chakra-ui/anatomy'
import { createMultiStyleConfigHelpers, defineStyle } from '@chakra-ui/react'

const { defineMultiStyleConfig } = createMultiStyleConfigHelpers(
  avatarAnatomy.keys,
)

export const avatarTheme = defineMultiStyleConfig({
  defaultProps: {
    size: 'superLg',
    variant: 'roundedSquare',
  },
})

// This saves you time, instead of manually setting the size and variant every time you use an avatar:
<Avatar variant="roundedSquare" size="superLg" ... />
// or
<AvatarGroup variant="roundedSquare" size="superLg">...</AvatarGroup>

Showcase#

import { Box, HStack, IconButton, Avatar, AvatarBadge, AvatarGroup, useColorMode } from "@chakra-ui/react";
import { FaMoon, FaSun } from "react-icons/fa";

export default function App() {
  const { toggleColorMode, colorMode } = useColorMode();
  return (
    <Box position="relative" h="100vh">
      <HStack spacing={8} p={12}>
        <Avatar name="Segun Adebayo" />
        <Avatar name="Lazar Nikolov" variant="roundedSquare">
          <AvatarBadge boxSize="1rem" />
        </Avatar>
        <AvatarGroup max={2} size="superLg" variant="roundedSquare">
          <Avatar name="Lazar Nikolov" variant="roundedSquare">
            <AvatarBadge />
          </Avatar>
          <Avatar name="Segun Adebayo" variant="roundedSquare">
            <AvatarBadge bg="orange.500" />
          </Avatar>
          <Avatar name="Segun Adebayo" variant="roundedSquare">
            <AvatarBadge bg="orange.500" />
          </Avatar>
        </AvatarGroup>
      </HStack>

      <IconButton
        aria-label="toggle theme"
        rounded="full"
        size="xs"
        position="absolute"
        bottom={4}
        left={4}
        onClick={toggleColorMode} icon={colorMode === "dark" ? <FaSun /> : <FaMoon />}
      />
    </Box>
  );
}

Edit this page on GitHub