Skeleton

The skeleton component is used to indicate that a component is loading. It is a visual representation of the component's structure, without the actual content.

Implementations

The component Skeleton is available in the following technologies:

CSS Components

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
round	boolean		If true, the skeleton will have rounded corners
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-skeleton 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-skeleton custom-str="fill:#06e7a3" />
z-theme	string		Sets the theme of the component. The possible values are light and dark. <z-skeleton 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 Variable	Type	Description
--z-skeleton--width	distance	Width of the skeleton
--z-skeleton--height	distance	Height of the skeleton
--z-skeleton--radius	distance	Radius of the skeleton
--z-skeleton--time	distance	Duration of the animation
--z-skeleton--bg-1	color	Background color 1
--z-skeleton--bg-2	color	Background color 2

Both hight and width can be customized using the --z-skeleton--height and --z-skeleton--width CSS custom properties respectively.

Also, the radius of the skeleton can be customized using the --z-skeleton--radius CSS custom property. The time of the animation can be customized using the --z-skeleton--time CSS custom property.

And finally, you can customize both background colors using the --z-skeleton--bg-1 and --z-skeleton--bg-2 CSS custom properties.

Related components