Skip to content

Stepper - Web Component

The Stepper component can be used imported from:

Playground

Parameters

The Web component uses the <z-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
labelstringLabel for the stepper
configstringConfiguration for the stepper
stepsnumberNumber of steps 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

Parameters use

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.

label

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

config

The config attribute is used to center the step counter and the label. By default, both the step counter and the label are aligned to the left. The only possible value is center.

steps

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

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 the first option value.

Browser support

Detected engine:  

  • Chromium

  • Webkit

  • Gecko

HTML Examples

CodeSandbox example