Scroll indicator

Implementations

The component ScrollIndicator 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
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-scroll-indicator 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-scroll-indicator custom-str="fill:#06e7a3" />
z-theme	string		Sets the theme of the component. The possible values are light and dark. <z-scroll-indicator z-theme="dark" />

From Figma to code

...

Customization

INFO

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

CSS Variable	Type	Description
--z-scroll-indicator--color	color	Color of the Scroll Indicator
--z-scroll-indicator--bg	color	Background color of the Scroll Indicator
--z-scroll-indicator--height	distance	Height of the Scroll Indicator

The color & background of the scroll indicator can be customized by setting the --z-scroll-indicator-color & --z-scroll-indicator-bg CSS custom property respectively.

Also you can customize the hight of the scroll indicator by setting the --z-scroll-indicator-height CSS custom property.

Related components