WaveMaker - Widgets API Documentation
  1. Classes
  2. WizardStep

File

projects/components/widgets/containers/wizard/src/wizard-step/wizard-step.component.doc.ts

Description

The wmWizardStep component defines the wizardstep widget.

Index

Methods
Inputs

Methods

onLoad
onLoad(widget: any, stepIndex: number)

Callback function which will be triggered when the widget is loaded.

Parameters :
Name Type Optional Description
widget any No

Instance of the wizardstep widget
stepIndex number No

Index of active wizard step
Returns : void
onNext
onNext(widget: any, currentStep: number, stepIndex: number)

Callback function which will be triggered when the next step button is clicked on widget.

Parameters :
Name Type Optional Description
widget any No

Instance of the wizardstep widget
currentStep number No

Instances of active wizardstep
stepIndex number No

Index of active wizardstep
Returns : void
onPrev
onPrev(widget: any, currentStep: number, stepIndex: number)

Callback function which will be triggered when the previous step button is clicked on widget.

Parameters :
Name Type Optional Description
widget any No

Instance of the wizardstep widget
currentStep number No

Instances of active wizardstep
stepIndex number No

Index of active wizardstep
Returns : void
onSkip
onSkip(widget: any, currentStep: number, stepIndex: number)

Callback function which will be triggered when the skip link is clicked on widget.

Parameters :
Name Type Optional Description
widget any No

Instance of the wizardstep widget
currentStep number No

Instances of active wizardstep
stepIndex number No

Index of active wizardstep
Returns : void

Inputs

class
Type : string

Class of the widget.
doneiconclass
Type : string

This property defines the class of the visited icon that is shown in the title of the step.
enableskip
Type : boolean
Default value : false

This property will be used to enable skip option on current step.

Bindable: true
iconclass
Type : string

This property defines the class of the icon that is shown in the title of the step.
name
Type : string

Name of the wizardstep widget.
show
Type : boolean
Default value : true

This property will be used to show/hide the wizardstep widget on the web page.

Bindable: true
subtitle
Type : string
Default value : 'Step SubTitle'

Sub Title of the wizardstep widget.
title
Type : string
Default value : 'Step Title'

Title of the wizardstep widget.

results matching ""

    No results matching ""