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

Parameters are the attributes that can be used to customize the component when using it in a project. They apply to the WebComponents implementation and wrappers and to the Vue and React CSS implementations. Some parameters names change between the implementations, in order to follow the conventions of each technology and framework.

For example, the param model is named ngModel in Angular, modelValue in Vue, but stays as model in React.

By default, all the parameters are optional or can be set in different, except for the ones marked as required

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

Name	Type	Slot	Description
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 dropdown elements in case layout is dropdown
image-src	string		The URL of the image for the profile
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
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