Avatar
The Avatar component is used to represent 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, AvatarGroup } from "@chakra-ui/react";
Usage
Avatar Sizes
The Avatar
component comes in 7 sizes.
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.
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.
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:
Note the use of
em
for the size of theAvatarBadge
. 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.
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
Avatar Props
Avatar
composes the Box
component so you can pass all its props. These are
props specific to the Avatar
component:
colorScheme
colorScheme
Color Schemes for Avatar
are not implemented in the default theme. You can extend the theme to implement them.
string
getInitials
getInitials
Function to get the initials to display
((name: string) => string)
icon
icon
The default avatar used as fallback when name
, and src
is not specified.
React.ReactElement
iconLabel
iconLabel
string
ignoreFallback
ignoreFallback
If true
, opt out of the avatar's fallback
logic and
renders the img
at all times.
boolean
loading
loading
Defines loading strategy
"eager" | "lazy"
name
name
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
string
onError
onError
Function called when image failed to load
(() => void)
referrerPolicy
referrerPolicy
Defining which referrer is sent when fetching the resource.
React.HTMLAttributeReferrerPolicy
showBorder
showBorder
If true
, the Avatar
will show a border around it.
Best for a group of avatars
boolean
size
size
"2xs" | "xs" | "sm" | "md" | "lg" | "xl" | "2xl" | "full"
"md"
src
src
The image url of the Avatar
string
srcSet
srcSet
List of sources to use for different screen resolutions
string
variant
variant
Variants for Avatar
are not implemented in the default theme. You can extend the theme to implement them.
string
Avatar Group Props
AvatarGroup
composes the Box
component so you can pass all its props. These
are props specific to the AvatarGroup
component:
children
required
children
required
The children of the avatar group.
Ideally should be Avatar
and MoreIndicator
components
ReactNode
colorScheme
colorScheme
Color Schemes for AvatarGroup
are not implemented in the default theme. You can extend the theme to implement them.
string
max
max
The maximum number of visible avatars
number
size
size
Sizes for AvatarGroup
are not implemented in the default theme. You can extend the theme to implement them.
string
spacing
spacing
The space between the avatars in the group.
SystemProps["margin"]
"-0.75rem"
variant
variant
Variants for AvatarGroup
are not implemented in the default theme. You can extend the theme to implement them.
string