Skip to content

Promo

Promotional content

Promo is a component meant to highlight a specific topic, make the users curious and lead them to related unabridged content. The choice of themes must be well considered to guide the users well in their journey through the website.

UX/UI Guidelines

Check the design documentation of the component in ZeroHeight.

Implementations

The component Promo 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
image-srcstringURL of the image
image-altstringAlt text of the image
configstringConfiguration of the promo
headerstringHeader of the promo
shapestringShape of the promo
button-textstringText of the button
button-iconstringIcon of the button
button-icon-rightbooleanIcon on the right of the button
categorystringCategory of the promo
contentstringContent of the promo
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-promo 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-promo custom-str="fill:#06e7a3" />
z-themestring

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

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

From Figma to code

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

  • Size select
  • Type select
  • Image select

Customization

INFO

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

CSS VariableTypeDescription
--z-promo--bgcolorBackground color for the promo
--z-promo--colorcolorText color for the promo

Accessibility

...