Zurich image

Implementations

The component ZurichImage is available in the following technologies:

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
image	string		The name of the image we want to display
image-alt	string		The alt text for the image
width	number		The width of the image
height	number		The height of the image
frame	number[]		Attribute used to crop the image
position	number[]		Attribute used to position the image
background	string		The background color of the image
quality	number		The quality of the image
rotate	number		The rotation of the image
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-zurich-image 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-zurich-image custom-str="fill:#06e7a3" />
z-theme	string		Sets the theme of the component. The possible values are light and dark. <z-zurich-image z-theme="dark" />

From Figma to code

This component is not available in Figma per se, but it's an extension of Image component. You can check the guidelines for the Image component to understand how to implement it.

But the sources are coming from the CDN proxied routes for the BlueRoom assets. These images are normally imported using our Figma plugin, which injects the image URL directly into the component. The name is shown then in the style used as the background, which will be image property or the URL param to use.

You can check the BlueRoom documentation for more information.

Customization

INFO

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

No customization tokens yet implemented for this component

...

Related components