Skip to main content

The Avatar web component

A content area to display user information and profile image.

Settings

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

Fallback textAlignIconShow on desktopShow on mobileLabelAlignmentLabelsPositionAllow wrappingMaintain space when hiddenMarginAlways show in edit modeSourceStylesHelper text

Properties

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

Text to display if there is no image or icon.


global

boolean

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


boolean

Whether the component is visible.


The horizontal alignment of the contents.

Values
left

Left alignment.

center

Center alignment.

right

Right alignment.

stretched

Justified alignment


The icon to display.

Values

You can select an icon or dynamically set one with a valid icon key.


id

string

The unique identifier.


imageSize

number

The size of the image, in pixels.


Whether the component is visible in the desktop layout.


Whether the component is visible in the mobile layout.


label

string

The text label to display.


The horizontal alignment of the label.

Values
left

Left of the input field.

top

Above the input field.


The label for the node.


The position of the label relative to the input field or value.

Values
top

Above the input field or value.

left

Left of the input field or value.


Whether the label can wrap to multiple lines.


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


The amount of margin to render outside.

Values
4px 8px

Normal margin.

0

No margin.


pluginType

string

The plugin type.


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


src

string

The data source.


style

object

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


The tooltip text to display.


Methods

JavaScript API methods for interacting with Avatar. 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.

avatar.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.

avatar.setHidden(hidden)
Parameters

boolean

Whether the component is visible.