The Avatar component for Retool Apps
A content area to display user information and profile image.
Properties
All properties for this object with supported data types or values. You can write JavaScript almost anywhere in Retool to manipulate or read property values.
clickable
Whether there is an enabled Click event handler.
| Type | boolean |
| Format | True/False |
| Configurability | Inspector > Interaction > Event handlers |
| Default | false |
Examples
falsetrue
fallback
Text to display if there is no image or icon.
| Type | string |
| Configurability | Inspector |
| Default | null |
horizontalAlign
The horizontal alignment of the contents.
| Type | string | ||||||||
| Format | Plain Text | ||||||||
| Configurability | Inspector > Appearance > Align | ||||||||
| Allowed Values |
| ||||||||
| Default | left |
icon
the icon to display.
| Type | string |
| Format | Icon Key |
| Configurability | Inspector > Content > Add-ons > Icon |
| Default | null |
Examples
false/icon:bold/shopping-gift
id
The unique identifier (name).
| Type | string |
| Format | Plain Text |
| Configurability | Inspector |
| Default | avatar1 |
Examples
falsequery1
falsebutton1
imageSize
The size of the avatar.
| Type | number | ||||||||||||
| Configurability | Read-only | ||||||||||||
| Allowed Values |
| ||||||||||||
| Default | null |
isHiddenOnDesktop
Whether to show or hide this object in the desktop layout.
| Type | boolean |
| Format | True/False |
| Configurability | Inspector > Appearance > Advanced > Show on desktop |
| Default | false |
Examples
falsetrue
isHiddenOnMobile
Whether to show or hide this object in the mobile layout.
| Type | boolean |
| Format | True/False |
| Configurability | Inspector > Appearance > Advanced > Show on mobile |
| Default | true |
Examples
falsetrue
labelPosition
The position of the label relative to the input field or value.
| Type | string | |||||||||
| Format | Plain Text | |||||||||
| Configurability | Inspector > Content > Add-ons > Label > Position | |||||||||
| Allowed Values |
| |||||||||
| Default | left |
Examples
falsetop
maintainSpaceWhenHidden
Whether to take up space on the canvas if hidden is true.
| Type | boolean |
| Format | True/False |
| Configurability | Inspector > Appearance > Advanced > Maintain space when hidden |
| Default | false |
Examples
falsetrue
margin
The amount of margin to render outside.
| Type | string | |||||||||
| Format | Plain Text | |||||||||
| Configurability | Inspector > Spacing > Margin | |||||||||
| Allowed Values |
| |||||||||
| Default | 4px 8px |
Examples
false4px 8px
showInEditor
Whether the component remains visible in the editor if hidden is true.
| Type | boolean |
| Format | True/False |
| Configurability | Inspector > Appearance > Advanced > Always show in edit mode |
| Default | false |
Examples
falsetrue
Examples
falsehttps://upload.wikimedia.org/wikipedia/commons/1/14/Marspathfinder.pdf
tooltipText
The tooltip text to display next to the label on hover.
| Type | string |
| Format | Markdown |
| Configurability | Inspector > Content > Add-ons > Helper text |
| Default | null |
Examples
falseSubmit
Methods
JavaScript API methods for this object. You can write JavaScript almost anywhere in Retool and use methods to manipulate data and property values.
avatar.scrollIntoView()
Scrolls the canvas or parent container so that the selected component appears in the visible area.
avatar.scrollIntoView(options)
Parameters
Object Properties
behavior
The scroll behavior.
| Type | string | ||||||
| Allowed Values |
|
block
The scroll position relative to the component.
| Type | string | ||||||||||
| Allowed Values |
|
Examples
Scroll the minimum amount to immediately bring avatar into view.
avatar.scrollIntoView({behavior: 'auto', block: 'nearest'});
avatar.setHidden()
Set the hidden value to toggle whether the component is visible. Defaults to true without a parameter.
avatar.setHidden(hidden)
Parameters
Examples
true
Examples
Hide avatar.
avatar.setHidden(true);
Unhide avatar.
avatar.setHidden(false);
Events
Events triggered by user interactions. You can configure event handlers in the IDE to trigger queries or other actions in response to events.
| Event | Description |
|---|