Skip to content

Vertical Stepper - Web Component โ€‹

The VerticalStepper component can be used imported from:

Playground โ€‹

Parameters โ€‹

The Web component uses the <z-vertical-stepper> tag:

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 HTML params:

NameTypeDescriptionSlotA11y
headerstringHeader for the stepperheader
stepsnumberNumber of steps of the stepper
configstringConfiguration of the stepper
modelnumberCurrent value of the stepper
disabledbooleanBlocks the stepper from being interacted with

Events โ€‹

This component has events. Check the documentation about how to use the events.

NamePayloadDescription
changenumberReturns the new value of the "value" attribute
restartedvoidEmitted on value reset

Slots โ€‹

This component has slots. Check the documentation about how to use the slots.

NameTagsDescription
headerspan

Parameters use โ€‹

steps โ€‹

The steps attribute is used to define the total number of steps in the stepper. If not provided, the default value is 10.

We can use <option> tags to define the values of steps

model โ€‹

The model attribute is used to define the current step in the stepper. Make sure the value is between 1 and the total number of steps.

The header attribute is used to define the header of the stepper.

config โ€‹

You can use the config attribute to display the stepper as collapsed.

Flags โ€‹

disabled โ€‹

The disabled attribute is used to block the interaction with the stepper.

Methods โ€‹

reset() โ€‹

We can all the reset() method of the WebComponent in order to reset the value. This will clean the internal states and emit the nullable value with the change event, plus a restarted event:

In this example, the button triggers the method:

Value:ย  1

The reset is done to 1.

Browser support โ€‹

Detected engine: ย 

  • Chromium

  • Webkit

  • Gecko

HTML Examples โ€‹

CodeSandbox example โ€‹