1.7.14 • Published 3 years ago

@belomx/timeu-wizard v1.7.14

Weekly downloads
13
License
MIT
Repository
github
Last release
3 years ago

Demo and API Docs

<timeu-wizard>

The timeu-wizard element displaying the progress of a wizard as a series of connected circles. By default the step number is displayed inside the circle and if provided a label below. The available steps are provided by either as an array of Objects or an array of Strings.

This branch (master) works only with Polymer 3.x.

Versions (Polymer 3.x)

The master branch and all 3.x.x .

How to use

Simple example:

-->

<timeu-wizard steps='["Step1","Step2","Step3"]' step="2"></timeu-wizard>

By providing an array of Objects users can provide custom contents for the circles.

Example with custom circle content:

<timeu-wizard steps='[{"label:Step1","content":"A"},{label:"Step2","content":"B"}]'></timeu-wizard>

It is also possible to display a vertical progress by adding the vertical attribute:

<timeu-wizard vertical steps='["Step1","Step2","Step3"]' step="2"></timeu-wizard>

Styling

The following custom properties and mixins are also available for styling:

Custom propertyDescriptionDefault
--timeu-wizard-line-colorThe color of the line#dfdfdf
--timeu-wizard-line-sizeThe thickness of the line1px
--timeu-wizard-line-filling-colorThe color of the of the line when is filled#2db36f
--timeu-wizard-circle-sizeThe size of the circle40px
--timeu-wizard-filling-colorThe collor of the filling of the line#2db36f
--timeu-wizard-anim-speedThe animation speed for the circles and lines0.5s
--timeu-wizard-active-colorThe color of finished steps and the current active step#2db36f
--timeu-wizard-label-font-sizeThe font-size of the labels13px
--timeu-wizard-step-font-sizeThe font-size of the steps inside of the circle25px
--timeu-wizard-circle-border-sizeThe thickness of the circle border1px
--timeu-wizardMixin applied to element host{}
--timeu-wizard-containerMixin applied to container div{}
--timeu-wizard-listMixin applied to steps list{}
--timeu-wizard-list-itemMixin applied to each step{}
--timeu-wizard-list-item-activeMixin applied to each active step{}
--timeu-wizard-list-item-doneMixin applied to each done step{}
--timeu-wizard-list-item-iconMixin applied to each step icon{}
--timeu-wizard-list-item-checkiconMixin applied to each done step icon{}
--timeu-wizard-list-item-labelMixin applied to each item label{}
--timeu-wizard-list-item-right-labelMixin applied to each item right label{}
--timeu-wizard-list-item-left-labelMixin applied to each item left label{}