Skip to Content

Avatar

Display user avatars with support for images, initials, icons, and status indicators.

Import

import { Avatar, AvatarGroup } from "@raydenui/ui";

Usage

Image Avatar

John Doe
<Avatar type="image" src="/avatar.jpg" alt="John Doe" />

Initials Avatar

JD
AB
CD
<Avatar type="initials" initials="JD" />

Icon Avatar

import { Icon } from "@raydenui/ui"; <Avatar type="icon" icon={<Icon name="user" />} />

Sizes

XS
SM
MD
LG
XL
<Avatar type="initials" initials="XS" size="xs" /> <Avatar type="initials" initials="SM" size="sm" /> <Avatar type="initials" initials="MD" size="md" /> <Avatar type="initials" initials="LG" size="lg" /> <Avatar type="initials" initials="XL" size="xl" />

With Status Indicator

<Avatar type="image" src="/avatar.jpg" status="online" /> <Avatar type="image" src="/avatar.jpg" status="offline" /> <Avatar type="image" src="/avatar.jpg" status="busy" /> <Avatar type="image" src="/avatar.jpg" status="away" />

Avatar Group

+5
<AvatarGroup> <Avatar type="image" src="/user1.jpg" /> <Avatar type="image" src="/user2.jpg" /> <Avatar type="image" src="/user3.jpg" /> <Avatar type="initials" initials="+5" /> </AvatarGroup>

Avatar Group with Max

+2
<AvatarGroup max={3}> <Avatar type="image" src="/user1.jpg" /> <Avatar type="image" src="/user2.jpg" /> <Avatar type="image" src="/user3.jpg" /> <Avatar type="image" src="/user4.jpg" /> <Avatar type="image" src="/user5.jpg" /> {/* Shows +2 overflow */} </AvatarGroup>

Props

Avatar

PropTypeDefaultDescription
type"image" | "initials" | "icon""initials"Avatar type
srcstring—Image source URL (image type)
altstring—Image alt text
initialsstring—Initials text (initials type)
iconReactNode—Icon element (icon type)
size"xs" | "sm" | "md" | "lg" | "xl""md"Avatar size
status"online" | "offline" | "busy" | "away"—Status indicator
classNamestring—Additional CSS classes

AvatarGroup

PropTypeDefaultDescription
maxnumber—Max avatars before overflow
size"xs" | "sm" | "md" | "lg" | "xl""md"Size for all avatars
classNamestring—Additional CSS classes

Accessibility

  • Images have proper alt text
  • Status indicators have screen reader labels
  • Uses semantic elements
Last updated on