Skip to content

Avatar - Web Component

The Avatar component can be used imported from:

Playground

Parameters

The Web component uses the <z-avatar> tag:

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 HTML params:

NameTypeDescriptionSlotA11y
configstring

Custom attribute for the article card component. Possible values are: horizontal, vertical or dropdown

namestringThe name of the user profilename
dropdown-elementsobject[]The dropdown elements in case layout is dropdown
image-srcstringThe URL of the image for the profile
initialsstringThe initials of the user profile
statusstringThe status of the user profile
badgeobjectThe badge for the profile
contentstringThe content of the user profiledefault

TIP

Check the badge and the profile components to learn more about the component.

Events

This component has events. Check the documentation about how to use the events.

NamePayloadDescription

Slots

This component has slots. Check the documentation about how to use the slots.

NameTagsDescription
defaultspan
namespan
profilez-profileThe profile of the user

Parameters use

content

The thing to be assigned to the avatar. It uses the default slot too.

Avatar content

config

The config attribute is used to set the orientation of the avatar. Possible values are: horizontal, vertical or dropdown.

name

The name attribute is used to set the name for the avatar. It can also use the name slot.

John Doe

The dropdown configuration requires the dropdown-elements attribute to be set.

Profile attributes

image-src

The image-src parameter is used to define the image URL to be displayed inside the avatar.

You can also use the images from the Zurich media images. Make sure you specify correctly the name of the image you want to display.

initials

The initials it`s used to set the initials for the avatar.

status

The status it's used to set the status for the avatar. Possible values are: online,occupied or absent

Alternatively, you can use the profile slot:

Badge attributes

badge

The badge it's used to set the badge for the avatar. It requires an object with the badge configuration.

Alternatively, you can directly place a <z-badge> tag in the default slot.

Browser support

Detected engine:  

  • Chromium

  • Webkit

  • Gecko

HTML Examples

CodeSandbox example