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:
Name | Type | Description | Slot | A11y |
---|---|---|---|---|
label | string | Label for the stepper | ||
config | string | Configuration for the stepper | ||
steps | number | Number of steps of the stepper | ||
model | number | Current value of the stepper | ||
disabled | boolean | Blocks the stepper from being interacted with |
Events โ
This component has events. Check the documentation about how to use the events.
Name | Payload | Description |
---|---|---|
change | number | Returns the new value of the "value" attribute |
restarted | void | Emitted 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