Skip to main content

Avatar

Ant Design

The Avatar component shows a user's picture, or their initials when there is no picture, for example next to a name in a profile or a list.

Properties​

Property
Description
Expected Value
SrcURL of the image to show.Text
TextText shown when there is no image. A full name with a space shows its initials, such as AL for Ada Lovelace.Text. Default: AL
AltAlternative text for the image, read by screen readers. When empty, Text is used.Text
ShapeWhether the avatar is round or a square with rounded corners.circle, square. Default: circle
Size (px)Width and height of the avatar, from 16 to 240 pixels. It shrinks to fit a smaller box.Number. Default: 40

Additional Actions​

Each of these can be switched on or off, or set with a logical expression by clicking fx.

Property
Description
Expected Value
VisibilityShows or hides the component. Hidden components keep their space unless Collapse when hidden is on.On or off. Default: On
Collapse when hiddenRemoves the hidden component's space, so the components below it move up.On or off. Default: Off
Loading stateShows the component's loading look and blocks interaction, for example while a query runs.On or off. Default: Off
DisableStops the user from interacting with the component.On or off. Default: Off

Devices​

Property
Description
Expected Value
Show on desktopShows the component in the desktop layout.On or off. Default: On
Show on mobileShows the component in the mobile layout.On or off. Default: Off

Component Specific Actions (CSA)​

Run these from an event handler with Control Component, or from a RunJS query. See Component Specific Actions.

Action
Description
How To Access
Set visibilityShows the component when true, hides it when false.components.avatar1.setVisibility(false)
Set disableDisables the component when true, enables it when false.components.avatar1.setDisable(false)
Set loadingTurns the loading state on with true, off with false.components.avatar1.setLoading(false)

Exposed Variables​

Variable
Description
How To Access
srcURL of the image to show.{{components.avatar1.src}}
childrenText shown when there is no image. A full name with a space shows its initials, such as AL for Ada Lovelace.{{components.avatar1.children}}
altAlternative text for the image, read by screen readers. When empty, Text is used.{{components.avatar1.alt}}
shapeWhether the avatar is round or a square with rounded corners.{{components.avatar1.shape}}
sizeWidth and height of the avatar, from 16 to 240 pixels. It shrinks to fit a smaller box.{{components.avatar1.size}}
isVisibleWhether the component is visible.{{components.avatar1.isVisible}}
isLoadingWhether the component is in its loading state.{{components.avatar1.isLoading}}
isDisabledWhether the component is disabled.{{components.avatar1.isDisabled}}

Styles​

Style
Default
Primary colorTheme: Brand primary
Text colorTheme: Primary text
Container backgroundTheme: Surface 1
Border colorTheme: Default border
Border radius—
Box shadow0px 0px 0px 0px #00000040

A default that starts with Theme: follows the app's theme until the style is set to another value. See App Themes.