Toggle Sidebar B
AppearanceLight & dark mode D

Avatar

User profile image with initials fallback, colourful mesh background, and status indicator. Pass a model object with name and optional profile_image to render.

Basic

Pass a model with a name; the avatar renders initials as a fallback.

Replay preview
SD
BC

Default

Auto-generates initials and a hashed mesh-gradient background from the name.

Replay preview
OM
JL
IN

Size

The avatar scales to its box, so set the dimensions with a size utility class.

Replay preview
OM
OM
OM
OM
OM

With image

Pass a profile_image map keyed by size (sm, md, lg).

Replay preview
Olivia Martin

Status indicator

Add a coloured dot for presence or status.

Replay preview
JL
JL
JL
JL

Rounding

circle for full round, rounded prop for any Tailwind rounded class.

Replay preview
IN
IN
IN
IN

API Reference

Avatar

PropTypeDefaultDescription
model{ name?: string, profile_image?: Record<string, string> }User-like object. Falls back to initials when profile_image is missing.
size"sm" | "md" | "lg""sm"Key used to pick the URL from profile_image.
roundedstring"rounded-lg"Tailwind rounded class. Use squircle for icon-style avatars.
circlebooleanfalseForce rounded-full.
colorfulbooleantrueEnable the auto-generated mesh-gradient background for initials.
gradientFramebooleanfalseInstagram-style rotating gradient frame around the avatar.
indicator"success" | "info" | "warning" | "destructive" | "primary"nullColoured dot in the bottom-right corner.
noTooltipbooleanfalseDisable name tooltip when inside AvatarGroup.