Avatar

Installation

bunx --bun shadcn@latest add @sui/avatar

Install with the shadcn CLI or use the shared @workspace/ui package. Follow the installation guide to configure the registry, load styles, and choose import aliases.

Usage

import { Avatar, AvatarFallback, AvatarImage } from "@workspace/ui/components/avatar"

<Avatar>
  <AvatarImage src="https://github.com/shadcn.png" />
  <AvatarFallback>CN</AvatarFallback>
</Avatar>

Composition

Use the following composition to build an Avatar:

Avatar
├── AvatarImage
├── AvatarFallback
└── AvatarBadge

Use the following composition to build an AvatarGroup:

AvatarGroup
├── Avatar
│   ├── AvatarImage
│   ├── AvatarFallback
│   └── AvatarBadge
├── Avatar
│   ├── AvatarImage
│   ├── AvatarFallback
│   └── AvatarBadge
└── AvatarGroupCount

Basic

A basic avatar component with an image and a fallback.

Badge

Use the AvatarBadge component to add a badge to the avatar. The badge is positioned at the bottom right of the avatar.

Use the className prop to add custom styles to the badge such as custom colors, sizes, etc.

<Avatar>
  <AvatarImage src="https://github.com/shadcn.png" alt="@shadcn" />
  <AvatarFallback>CN</AvatarFallback>
  <AvatarBadge className="bg-green-600 dark:bg-green-800" />
</Avatar>

Badge with Icon

You can also use an icon inside <AvatarBadge>.

Avatar Group

Use the AvatarGroup component to add a group of avatars.

Avatar Group Count

Use <AvatarGroupCount> to add a count to the group.

Avatar Group with Icon

You can also use an icon inside <AvatarGroupCount>.

Sizes

Use the size prop to change the size of the avatar.

Dropdown

You can use the Avatar component as a trigger for a dropdown menu.

RTL

To enable RTL support in shadcn/ui, see the RTL configuration guide.

API Reference

Avatar

The Avatar component is the root component that wraps the avatar image and fallback.

AvatarImage

The AvatarImage component displays the avatar image. It accepts all Base UI Avatar Image props.

AvatarFallback

The AvatarFallback component displays a fallback when the image fails to load. It accepts all Base UI Avatar Fallback props.

AvatarBadge

The AvatarBadge component displays a badge indicator on the avatar, typically positioned at the bottom right.

AvatarGroup

The AvatarGroup component displays a group of avatars with overlapping styling.

AvatarGroupCount

The AvatarGroupCount component displays a count indicator in an avatar group, typically showing the number of additional avatars.

For more information about Base UI Avatar props, see the Base UI documentation.