Skip to content

Profile

PZ

Profile is used to represent a user and add visual information in form of an icon, initials or image.

Implementations

The component Profile 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:

NameTypeSlottableDescription
configstring

The main parameter has three components following the pattern: <size><?:color><?:style>

  • size: Defines the size of the profile. Possible values are: l, m, s
  • color: Defines the color of the profile. Possible values are: 1, 2, 3, 4, 5, 6
  • outline: If outline parameter is present, the profile will be rendered with a border.
statusstring

Defines the status of the profile. Possible values are: online, absent,occupied

initialsstringDefines the initials of the user. Only the first two characters will be displayed.
image-srcstringDefines the `src` attribute pointing to the user's profile picture. Default fallback it's a user icon
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-profile custom='{"fill":"#06e7a3"}' />
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-profile custom-str="fill:#06e7a3" />
z-themestring

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

html
<z-profile z-theme="dark" />

From Figma to code

You can check the Figma implementation here.

Customization

INFO

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

CSS VariableTypeDescription
--z-profile--bgcolorBackground color
--z-profile--colorcolorForeground color
--z-profile--sizedistanceSize fof the profile
--z-profile--border-colorcolorBorder color

The background, color and size of the profile can be customized using the --z-profile--background, --z-profile--color and --z-profile--size CSS custom properties respectively or the custom attribute.

AZ
AZ

Also for the outline version of the profile, the border color can be customized using the --z-profile--border-color CSS custom property.

AZ
AZ