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 | ||||
| Mutability |
| ||||
| Default | |
Examples
true
fallback
Text to display if there is no image or icon.
| Type | string | ||||
| Mutability |
|
horizontalAlign
The horizontal alignment of the contents.
| Type | string | ||||||||
| Format | Plain Text | ||||||||
| Mutability |
| ||||||||
| Allowed Values |
| ||||||||
| Default | |
icon
the icon to display.
| Type | string | ||||
| Format | Icon Key | ||||
| Mutability |
| ||||
| Default | |
Examples
/icon:bold/shopping-gift
imageSize
The size of the avatar.
| Type | number | ||||||||||||
| Mutability | Read-only | ||||||||||||
| Allowed Values |
|
labelPosition
The position of the label relative to the input field or value.
| Type | string | |||||||||
| Format | Plain Text | |||||||||
| Mutability |
| |||||||||
| Allowed Values |
| |||||||||
| Default | |
Examples
top
tooltipText
The tooltip text to display next to the label on hover.
| Type | string | ||||
| Format | Markdown | ||||
| Mutability |
| ||||
| Default | |
Examples
Submit
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
options Required
The scroll options.
Object Properties
behavior Required
The scroll behavior.
Supported Values
auto | Scroll immediately to the specified position. |
smooth | Scroll gradually to the specified position. |
block Required
The scroll position relative to the component.
Supported 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. |
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
hidden
Whether this object is hidden from view.
Examples
Hide avatar.
avatar.setHidden(true);
Unhide avatar.
avatar.setHidden(false);
Events
Events triggered by user interactions. Use event handlers to trigger queries or other actions in response to events.