Avatar Group
Server ComponentOverlapping avatar stack with a "+N" overflow chip.
Import
tsx
import { AvatarGroup } from "@cronus-ui/ui";
bash
npx cronus-ui add avatar-group
Examples
.cronus
The same component declared in Cronus. Emitted at build time from the audit fixtures — the kernel renders it as HTML with no React.
default.cronus
app "audit-fixtures" {
port 5176
}
style {
preset aurora
theme dark
}
component AvatarGroupDefault layout:inline style:avatar-group {
aria-label:"Team"
label "Team"
text "AL"
text "JB"
}
page "/audit/avatar-group/default" type:custom {
use AvatarGroupDefault
}
API Reference
Generated from the component's exported types.
AvatarGroupProps
Extends HTMLAttributes<HTMLDivElement>, VariantProps<typeof avatarGroupItemVariants>
| Prop | Type | Default | Description |
|---|---|---|---|
avatars | AvatarGroupAvatar[] | — | Avatars to stack. Compose `<Avatar>` children, or pass `avatars` for the data-driven shorthand. `avatars` takes precedence when both are provided. |
max | number | — | Show the first `max` avatars, then a "+N" overflow chip for the rest. |
spacing | string | "-space-x-2" | Horizontal overlap between avatars as a Tailwind negative-margin class (e.g. `-space-x-2`). Defaults to a tasteful offset. |
size | "sm" | "md" | "lg" | "md" | One of "sm" | "md" | "lg". |
asChild | boolean | — | Render as the child element via Slot. |
children | ReactNode | — | Contents of the component. |
className | string | — | Additional class names merged onto the root. |
id | string | — | DOM id of the root element. |