Skip to content

Safe space

Implementations

The component SafeSpace is available in the following technologies:

CSS Components
cssreactvue
Web Components
webreactvueangular
Native
react_native

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 two components following the pattern: <zLetterSize><?:size> where:

  • zLetterSize: [number] defines the size of the letter inside the safe space. Possible values are: 2, 3, 4, 5.
  • size: [number] defines the size of the safe space. Possible values are: 20, 25, 30, 35, 40, 45, 50 (rem).
image-srcstringDefines the `src` attribute pointing to the image.
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-safe-space 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-safe-space custom-str="fill:#06e7a3" />
z-themestring

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

html
<z-safe-space z-theme="dark" />

From Figma to code

You can check the Figma implementation here. The components is separated into two components:

Both share the same properties:

  • Proportion select
  • Size select

Customization

INFO

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

CSS VariableTypeDescription
--z-safe-space--bgcolorBackground color
--z-safe-space--sizedistanceSize of Safe Space
--z-safe-space--image-xdistanceImage x adjustment
--z-safe-space--image-ydistanceImage Y adjustment

The background color is customizable using the --z-safe-space--bg CSS custom property.

The size of the safe space can also be customized using the --z-safe-space--size CSS custom property.

You can determine the x and y position of the image inside the safe space using the --z-safe-space--image-x and --z-safe-space--image-y CSS custom properties.