AvatarGroup to show multiple avatars with overflow handling.
Basic usage
With fallback text
When the image fails to load or no src is provided, the fallback is displayed.Sizes
Avatar supports 13 size variants from 1 to 13.Colors
Choose from 13 color variants.Variants
Avatar supportssolid and soft variants.
Border radius
Control the border radius with theradius prop.
Avatar group
Display multiple avatars with automatic overflow handling.Automatic color selection
Use thegetAvatarColor utility to generate consistent colors based on a string.
API reference
Avatar
string
Image source URL.
string
Alternative text for the image.
ReactNode
Content to display when the image fails to load or is not provided.
1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13
default:"3"
Size of the avatar.
'small' | 'full'
default:"'small'"
Border radius of the avatar.
'solid' | 'soft'
default:"'soft'"
Visual style variant.
'indigo' | 'orange' | 'mint' | 'neutral' | 'sky' | 'lime' | 'grass' | 'cyan' | 'iris' | 'purple' | 'pink' | 'crimson' | 'gold'
default:"'indigo'"
Color theme for the avatar fallback.
string
Additional CSS classes to apply.
boolean
Whether the avatar should appear disabled.
AvatarGroup
React.ReactElement<AvatarProps>[]
required
Array of Avatar components to display.
number
Maximum number of avatars to display before showing overflow count.
string
Additional CSS classes to apply to the group container.
getAvatarColor
Utility function to generate a consistent color based on a string input.string
required
Input string (e.g., email or username) to generate color from.