Skip to content

SusAvatarGroup

SusAvatarGroup

Stacked party / roster avatars with overflow +N when Items exceed Max.

Package

SusKit · Atoms (commercial)

Open in Playground

SusKit · Atoms

Props

NameTypeDefault
MaxProp<int>3v-model
SizeProp<string>"default"v-model
RoundedProp<string>"circle"v-model

Slots

No slots.

Events

No public events.

Style hooks

USS class contract — override appearance without touching C#. States toggle via these classes:

  • sus-avatar-group
  • sus-avatar-group__avatar
  • sus-avatar-group__avatar--first
  • sus-avatar-group__more
  • sus-avatar-group__row
  • sus-avatar-group--default
  • sus-avatar-group--large
  • sus-avatar-group--small
  • sus-avatar-group--x-large
  • sus-avatar-group--x-small

Usage

Items are set in code (List<AvatarGroupItem>). Each item carries Text, optional Image / Color / Status.

csharp
var group = new SusAvatarGroup();
group.Size.Value = "default";
group.Max.Value = 3;
group.Rounded.Value = "circle";
group.Items.Value = new List<SusAvatarGroup.AvatarGroupItem>
{
    new() { Text = "Alice", Color = "primary", Status = "online" },
    new() { Text = "Bob", Color = "success", Status = "away" },
    new() { Text = "Cara", Color = "info", Status = "busy" },
    new() { Text = "Dan", Color = "warning", Status = "offline" },
};
PropRole
ItemsList<AvatarGroupItem> — faces to stack
MaxHow many avatars before +N overflow
Size / RoundedApplied to every child avatar