Skip to content

Avatar list

PC

Avatar lists are groups of more than one avatar (e.g. to show a group of people pertaining to the same team).

An avatar list is made up of several Profile components; read the specification in the Profile page to learn more about it.

UX/UI Guidelines

Check the design documentation of the component in ZeroHeight.

Implementations

The component AvatarList is available in the following technologies:

CSS Components
cssreactvue
Web Components
webreactvueangular

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:

NameTypeSlotDescription
profilesObject[]The profiles to display
customobject

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:

html
<z-avatar-list custom='{"fill":"#06e7a3"}' />

Check the available values in the customization section.

custom-strstring

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:

html
<z-avatar-list custom-str="fill:#06e7a3" />
z-themestring

Sets the theme of the component. The possible values are light and dark.

html
<z-avatar-list z-theme="dark" />

From Figma to code

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

  • Size select
  • Items select

Customization

INFO

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

CSS VariableTypeDescription
--z-avatar-list--bg-1colorBackground color for the first avatar
--z-avatar-list--bg-2colorBackground color for the second avatar
--z-avatar-list--bg-3colorBackground color for the third avatar
--z-avatar-list--bg-4colorBackground color for the fourth avatar
--z-avatar-list--bg-5colorBackground color for the fifth avatar

Each background color of the avatar in the list can be customized by using the CSS custom token --z-avatar-list--bg-1 to a maximum of 5 with --z-avatar-list--bg-5

Accessibility

...