2.0 alpha

These docs describe 2.0. Install it with @once-ui-system/core@alpha.

Components

AvatarGroup

Updated: May 5, 2025

A component for displaying multiple user avatars in a compact, horizontal stack. Commonly used in collaborative interfaces to show team members, participants, or contributors.

AvatarGroup

B

C

D

E

<AvatarGroup
  size="l"
  avatars={[
    { src: "/images/avatar.jpg" },
    { value: "B" },
    { value: "C" },
    { value: "D" },
    { value: "E" }
  ]}
/>

Sizes

AvatarGroup supports the same T-shirt sizing model as Avatar.

Sizes

A

B

C

D

A

B

C

D

A

B

C

D

A

B

C

D

A

B

C

D

<AvatarGroup
  size="s"
  avatars={[
    { value: "A" },
    { value: "B" },
    { value: "C" },
    { value: "D" }
  ]}
/>

Limit

Use the limit prop to control how many avatars are displayed. Any additional avatars will be represented by a count indicator.

Limit

A

B

C

+4

A

B

C

D

+1

<AvatarGroup
  size="m"
  limit={3}
  avatars={[
    { value: "A" },
    { value: "B" },
    { value: "C" },
    { value: "D" },
    { value: "E" },
    { value: "F" },
    { value: "G" }
  ]}
/>

Reverse order

Use the reverse prop to change the stacking order of avatars.

Reverse

A

B

C

A

B

C

<AvatarGroup
  size="m"
  avatars={[
    { value: "A" },
    { value: "B" },
    { value: "C" },
  ]}
/>

<AvatarGroup
  size="m"
  reverse
  avatars={[
    { value: "A" },
    { value: "B" },
    { value: "C" },
  ]}
/>

Mixed types

AvatarGroup supports all the same avatar types as the Avatar component.

Mixed

B

D

<AvatarGroup
  size="m"
  avatars={[
    { src: "/images/avatar.jpg" },
    { value: "B" },
    { empty: true },
    { value: "D", statusIndicator: { color: "green" } }
  ]}
/>

API reference

Prop	Type	Default
avatarsrequired The people, in order.	AvatarProps[]	—
size Size of every avatar in the stack.	xllmsxs	m
reverse Stack from the other side.	boolean	false
limit Show at most this many, then a +N.	number	—
className	string	—
style	React.CSSProperties	—
…and every FlexProps prop	inherited	—

ComponentsAvatar

ComponentsBackground

Edit this page on GitHub

Built with curiosity by Lorant One and the Design Engineers Club