AvatarGroup

Render a compact group of Astryx avatars.

Astryx Props

JSON-safe AvatarGroup props forwarded to Astryx.

Supported Astryx props include:

children (ReactNode; required): Avatar children, optionally followed by one AvatarGroupOverflow. Consumers handle slicing to the desired visible count.
size (AvatarSize): Size applied to all avatars via context.
ref (React.Ref<HTMLDivElement>): Ref forwarded to the root element.
xstyle (StyleXStyles): StyleX styles for layout customization.
data-testid (string): Test selector for automated testing frameworks.

Props typed as React nodes, render functions, event handlers, refs, or StyleX styles are documented for Astryx parity but cannot be serialized directly from Python unless the wrapper adapts them.

See Astryx component docs: https://astryx.atmeta.com/components/AvatarGroup.

Functions

constructor__init__(items, *, overflow_count=0, size=None, **props) -> None

paramitemsIterable[Any]

Item records used by generated child components or static search sources.

paramoverflow_countint

= 0

Number shown in the avatar-group overflow indicator.

paramsizestr | None

= None

Avatar size used by the group.

parampropsAny

= {}

Returns

None

Functions

On this page