Skip to main content

Avatar (ALPHA)

Alpha feature: invite only

Responsive Widgets are in alpha and available by invitation only on Business and Enterprise plans. Behavior and properties may change. To request access, open a support ticket and name the feature Responsive Widgets (ALPHA).

The Avatar widget shows a picture of a person or an entity. If there is no picture, or the picture cannot load, it shows initials from the label. If it cannot make initials, it shows a user icon. It can also show a presence dot, such as online or busy.

Widget type: WDS_AVATAR_WIDGET

Avatar widget in a Responsive app
Avatar widget

Content properties​

These properties appear in the Content tab of the property pane.

Data​

Image string​

Sets the URL of the picture. You can bind data to it, for example {{AnvilTable1.selectedRow.photoUrl}}.

For safety, the widget only loads these values:

  • https:// URLs
  • URLs on the same origin as the app, including relative paths
  • Base64 raster image data, for example data:image/png;base64,.... Supported types are PNG, JPEG, GIF, WebP, AVIF, and BMP.

The widget does not load any other value, such as http:// URLs from another site, SVG data, blob: URLs, or javascript: URLs. In that case, it shows the initials or the icon instead. It sends no referrer when it loads the picture.

Label string​

Sets the name of the person or entity. Default: Ada Lovelace. This property is required.

The widget uses the label in two ways:

  • Screen readers announce it as the avatar's name.
  • The widget makes the initials from it. It takes the first letter of the first two words, in capitals. For example, Ada Lovelace shows as AL.

General​

Presence string​

Shows a status dot on the avatar. Options: None (default), Online, Busy, Away. Screen readers hear the status after the label, for example "Ada Lovelace (online)."

Values for code: none, online, busy, away.

Visible boolean​

Controls whether the widget is visible. Default: on.

Animate loading boolean​

Controls the loading animation of the widget. Default: on.

Style properties​

These properties appear in the Style tab of the property pane.

General​

Size string​

Sets the size of the avatar. Options: Small, Medium (default), Large, Extra large.

Values for code: S, M, L, XL.

Shape string​

Sets the shape of the avatar. Options: Circle (default), Square.

Values for code: circle, square.

Custom styling​

These settings are in the Custom styling section, at the end of the Style tab. An empty setting uses the theme value. For theme colors, dark mode, and the rules for custom CSS, see Custom styling.

Accent color string​

Builds the hover, pressed, focus, and text colors of this widget from one color, in light and dark mode. Lists and menus that the widget opens use them too. Empty means the accent of the nearest container that sets one, or the theme accent.

Custom CSS string​

Adds plain CSS to this widget. Rules apply only inside the widget, and & is the box around the widget, its label included, not the part inside it. To style an inner part, use its element selector, for example button or input. You cannot bind this property.

Reference properties​

Reference properties let you read the widget's state in bindings and code, for example {{Avatar1.isVisible}}. You cannot set them directly.

isVisible boolean​

Shows whether the widget is visible.

Example:

{{Avatar1.isVisible}}

image string​

The picture URL set on the widget.

Example:

{{Avatar1.image}}

label string​

The name of the person or entity.

Example:

{{Avatar1.label}}

presence string​

The presence status: none, online, busy, or away.

Example:

{{Avatar1.presence}}

Methods​

Methods let you change the widget's properties from code, for example in a JS Object.

setVisibility (param: boolean): Promise​

Shows or hides the widget.

Example:

Avatar1.setVisibility(false)

setImage (param: string): Promise​

Sets the picture URL. The same safety rules as the Image property apply.

Example:

Avatar1.setImage("https://example.com/photo.png")

setLabel (param: string): Promise​

Sets the label. This also changes the initials.

Example:

Avatar1.setLabel("Grace Hopper")

Events​

onClick​

Runs when users click the avatar. When you set this event, the avatar acts as a button.