The avatar component from Flowbite React can be used to show a visual representation of a user or team account for your application based on multiple examples, colors, sizes and shapes.

All of the example are built as React components and you can access custom props and methods to customize the component and you can also use Tailwind CSS classes to style the component.

To start using the avatar component you need to import it from the flowbite-react package:

import { Avatar } from "flowbite-react";

Default avatar#

Here's a default example of the <Avatar> component where you can use the img prop to pass the image URL, the alt prop to pass a description of the image for accessibility and the rounded prop to make the avatar rounded.

Avatar with border#

Use the bordered prop to add a border style to the avatar.

Avatar placeholder#

If the user doesn't have an image you can use the placeholder prop to show a placeholder image and you can still pass the rounded prop to make the avatar rounded and other options.

Placeholder initials#

Alternatively to the placeholder image you can use the placeholderInitials prop to show the user initials.

Dot indicator#

You can use the status prop to show a dot indicator on the avatar and you can use the statusPosition prop to change the position of the dot indicator.

This is useful to show the user status like online, offline, busy, away, and more.

Stacked layout#

Stack multiple avatars together by using the <AvatarGroup> component and by passing the stacked prop to the child components of the group.

The <AvatarGroupCounter> component can be used to show the total number of avatars in the group by passing the total prop and a link to the href prop to view all users.

Avatar with text#

Use this example to show an avatar with text (ie. user name, email, etc) by passing the custom markup inside the <Avatar> component. This is useful for admin dashboard interfaces while the user is logged in.

Avatar dropdown#

Use the <Dropdown> component to show a dropdown menu when clicking on the avatar component. This example is often used to show the user settings, account settings, and more.

Colors#

If you want to change the default color of the avatar component you can pass the color prop. Colors that you can choose from are gray, light, purple, success, pink, and more.

Sizes#

Change the default size of the avatar component by passing the size prop. Sizes that you can choose from are xs, sm, md, lg, and xl.

Override image element#

You can override the default image element by passing the img prop to the <Avatar> component. This is useful if you want to use a different image element like <Image> from Next.js.

Theme#

To learn more about how to customize the appearance of components, please see the Theme docs.

{
  "root": {
    "base": "flex items-center justify-center space-x-4 rounded",
    "inner": "relative",
    "bordered": "p-1 ring-2",
    "rounded": "rounded-full",
    "color": {
      "dark": "ring-gray-800 dark:ring-gray-800",
      "failure": "ring-red-500 dark:ring-red-700",
      "gray": "ring-gray-500 dark:ring-gray-400",
      "info": "ring-cyan-400 dark:ring-cyan-800",
      "light": "ring-gray-300 dark:ring-gray-500",
      "purple": "ring-purple-500 dark:ring-purple-600",
      "success": "ring-green-500 dark:ring-green-500",
      "warning": "ring-yellow-300 dark:ring-yellow-500",
      "pink": "ring-pink-500 dark:ring-pink-500"
    },
    "img": {
      "base": "rounded",
      "off": "relative overflow-hidden bg-gray-100 dark:bg-gray-600",
      "on": "",
      "placeholder": "absolute -bottom-1 h-auto w-auto text-gray-400"
    },
    "size": {
      "xs": "h-6 w-6",
      "sm": "h-8 w-8",
      "md": "h-10 w-10",
      "lg": "h-20 w-20",
      "xl": "h-36 w-36"
    },
    "stacked": "ring-2 ring-gray-300 dark:ring-gray-500",
    "statusPosition": {
      "bottom-left": "-bottom-1 -left-1",
      "bottom-center": "-bottom-1",
      "bottom-right": "-bottom-1 -right-1",
      "top-left": "-left-1 -top-1",
      "top-center": "-top-1",
      "top-right": "-right-1 -top-1",
      "center-right": "-right-1",
      "center": "",
      "center-left": "-left-1"
    },
    "status": {
      "away": "bg-yellow-400",
      "base": "absolute h-3.5 w-3.5 rounded-full border-2 border-white dark:border-gray-800",
      "busy": "bg-red-400",
      "offline": "bg-gray-400",
      "online": "bg-green-400"
    },
    "initials": {
      "text": "font-medium text-gray-600 dark:text-gray-300",
      "base": "relative inline-flex items-center justify-center overflow-hidden bg-gray-100 dark:bg-gray-600"
    }
  },
  "group": {
    "base": "flex -space-x-4"
  },
  "groupCounter": {
    "base": "relative flex h-10 w-10 items-center justify-center rounded-full bg-gray-700 text-xs font-medium text-white ring-2 ring-gray-300 hover:bg-gray-600 dark:ring-gray-500"
  }
}

References#