Avatar

Avatars add additional visual information about a user or team.

UX/UI Guidelines

Check the design documentation of the component in ZeroHeight.

Implementations

The component Avatar is available in the following technologies:

CSS Components

Web Components

Parameters

Parameters

Make sure you have read about the parameters in here.

The parametrization of the component can be done with the following custom params or properties:

Name	Type	Slot	Description
image-src	string	✅	The image-src is the URL of the image to be used.
image-alt	string		Alternative text for image accessibility
cross-origin	string		The crossorigin attribute of the image. Provides support for CORS, defining how the element handles cross-origin requests, thereby enabling the configuration of the CORS requests for the element's fetched data.
config	string		Custom attribute for the article card component. Possible values are: horizontal, vertical or dropdown
name	string	✅	The name of the user profile
dropdown-elements	object[]		The ActionMenu elements in case config is dropdown
initials	string		The initials of the user profile
status	string		The status of the user profile
badge	object		The badge for the profile
content	string	✅	The content of the user profile
profile-config	string
custom	object		A record of key-value pairs to set the CSS custom tokens. It's a complex attribute set as an JS object in stringified JSON format. Example: <z-avatar custom='{"fill":"#06e7a3"}' /> Check the available values in the customization section.
custom-str	string		The stringified version of the custom property. It follows the pattern key:value;key:value;, with the possibility of setting multiple values and spaces between the punctuation characters. Example: <z-avatar custom-str="fill:#06e7a3" />
z-theme	string		Sets the theme of the component. The possible values are light and dark. <z-avatar z-theme="dark" />

From Figma to code

You can check the Figma implementation here. This are the available properties:

• Style select
• Type select
• Size select

Customization

INFO

Check everything about the customization mechanics in the "How it works" documentation.

CSS Variable	Type	Description
--z-avatar--bg	color	The background color of the profile
--z-avatar--color	color	The text color of the profile
--z-avatar--border-color	color	The border color of the profile
--z-avatar--size	distance	The size of the profile

Both background and text color of the avatar can be customized using the --z-avatar--bg and --z-avatar--color CSS custom properties.

Additionally, the border color and the size of the avatar can be customized using the --z-avatar--border-color and --z-avatar--size CSS custom properties.

Description

Accessibility

...

Related components