The Avatar Group web component

A group of avatars to display information and profile images for users.

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.

Demo

Settings

Avatar Group includes the following configurable options when building apps in the IDE.

Fallback textsHiddenAlignShow on desktopShow on mobileMaintain space when hiddenMarginMax avatarsAlways show in edit modeStylesHelper text

Properties

All properties for Avatar Group with supported data types or values. You can write JavaScript almost anywhere in Retool to manipulate or read property values.

fallbacks

string[]

A list of text to display if there are no images or icons.

---

global

boolean

Whether the object is globally scoped for use in all app pages.

---

hidden

boolean

Whether the component is visible.

---

horizontalAlign

enum

The horizontal alignment of the contents.

Values

left	Left alignment.
center	Center alignment.
right	Right alignment.
stretched	Justified alignment

---

id

string

The unique identifier.

---

images

string[]

A list of image URLs to display.

---

imageSize

number

The size of the image, in pixels.

---

isHiddenOnDesktop

boolean

Whether the component is visible in the desktop layout.

---

isHiddenOnMobile

boolean

Whether the component is visible in the mobile layout.

---

maintainSpaceWhenHidden

boolean

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

---

margin

enum

The amount of margin to render outside.

Values

4px 8px	Normal margin.
0	No margin.

---

maxItems

number

The maximum number of items to show.

---

pluginType

string

The plugin type.

---

showInEditor

boolean

Whether to remain visible in the editor if hidden is true.

---

style

object

Custom style options in use. Not all style options may be available for all components.

---

tooltipText

string

The tooltip text to display.

---

Methods

JavaScript API methods for interacting with Avatar Group. You can write JavaScript almost anywhere in Retool and use methods to manipulate data and property values.

scrollIntoView

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

avatarGroup.scrollIntoView(scrollIntoViewOptions)

Parameters

scrollIntoViewOptions

object

The scroll options.

Properties

behavior

enum

The scroll behavior.

Values

auto	Scroll immediately to the specified position.
smooth	Scroll gradually to the specified position.

---

block

enum

The scroll position relative to the component.

Values

nearest	Scrolls only the minimum amount required for the component to appear in the visible area. Scrolling does not occur if the component is already in view.
start	Scrolls to position the component at the top of the visible area.
center	Scrolls to position the component in the middle of the visible area.
end	Scrolls to position the component at the bottom of the visible area.

---

---

---

setHidden

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

avatarGroup.setHidden(hidden)

Parameters

hidden

boolean

Whether the component is visible.

---

---