Avatar Group

A collection of avatars to display information and profile images for multiple users. It supports a range of image sizes, fallback text if no images are provided, and include label and captions.

Avatar Group adjusts the number of avatars shown to fit within its width or according to the specified maximum number, whichever is smaller. If there are more, the final avatar is a count of user photos that cannot be shown.

Properties

Available properties for Avatar Group with supported data types or values. You can write JavaScript almost anywhere in Retool to manipulate or read information about components.

NameTypeDescriptionfallbacksstring[]

A list of fallback text to display if there is no image or icon. Only the first two characters are displayed. If multiple words are provided, the first letter of each word is used.

hiddenboolean

Whether the component is visible.

horizontalAlign'left' | 'center' | 'right'

The horizontal alignment of the contents.

imageSize16 | 24 | 32 | 40 | 48

The size of the image, in pixels.

imagesstring[]

A list of image URLs to display.

maintainSpaceWhenHiddenboolean

Whether the component takes up space on the canvas if hidden is true.

marginstring

The amount of margin to render outside of the component.

maxItemsnumber | null

The maximum number of avatars to display. If there are more avatars than space allows, the last avatar displays a count of all those not currently rendered.

showInEditorboolean

Whether the component remains visible in the editor if hidden is true.

tooltipTextstring

The text to display in a tooltip on hover or focus.

Methods

Methods for interacting with Avatar Group. You can write JavaScript almost anywhere in Retool and use methods to manipulate data or components.

NameDescriptionscrollIntoView(options: any)

Scrolls the canvas or parent container so that the selected component appears in the visible area.

setHidden(hidden: boolean)

Set the hidden value to toggle whether the component is visible. Defaults to true without a parameter.

Related components