Content v1.0.0

Avatar

User or entity representation with image, initials fallback, and optional status indicator. Includes Avatar Group mode for stacking multiple avatars with configurable overlap and "+N more" overflow handling. Supports five sizes, two shapes, four status states, and deterministic auto-generated background colors from initials.

Preview & Code

Options

Name Type Default Description
src String Image URL for the avatar
alt String Alt text for the avatar image
initials String Fallback initials displayed when no image is provided (e.g. "JD")
size Symbol :md Avatar size: :xs, :sm, :md, :lg, :xl
status Symbol Online status indicator: :online, :offline, :busy, :away
shape Symbol :circle Avatar shape: :circle or :rounded
href String Optional link URL — wraps the avatar in an anchor tag
color String Background color class for initials (auto-generated from initials if nil)
group Boolean false Whether this avatar is part of a group (adds negative margin and ring)
group_items Array Array of avatar config hashes for group mode rendering
max_display Integer 4 Maximum number of avatars to show before the "+N more" overflow pill

Changelog v1.0.0

- v1.0.0: Initial release with single avatar and avatar group modes
- Five sizes (xs through xl), two shapes (circle, rounded)
- Status indicators (online, offline, busy, away)
- Deterministic initials color generation
- Stimulus-powered expandable overflow in group mode

Get Full Access

Unlock the source code for this component and all others. One-time payment for lifetime access.

Get Access Now