File

projects/components/src/widgets/common/wizard/wizard.component.doc.ts

Description

The wmWizard component defines the wizard widget.

Index

Methods
Inputs

Methods

onCancel
onCancel(widget: any, steps: Array)

Callback function which will be triggered when the widget cancel button is clicked.

Parameters :
Name Type Optional Description
widget any No

Instance of the wizard widget

steps Array<any> No

Instances of wizardsteps.

Returns : void
onDone
onDone(widget: any, steps: Array)

Callback function which will be triggered when the done button is clicked.

Parameters :
Name Type Optional Description
widget any No

Instance of the wizard widget

steps Array<any> No

Instances of wizardsteps

Returns : void

Inputs

actionsalignment

This property sets placement of actions.

Allowed Values: left, right

left: The next, done, prev buttons will be placed left and skip will be placed right

right: The next, done, prev buttons will be placed Right and skip will be placed left

Type : string

Default value : 'right'

cancelable

This property will be used to show/hide cancel button in the wizard widget.

Bindable: true

Type : boolean

Default value : true

cancelbtnlabel

This property defines the caption for Cancel step.

Bindable: true

Type : string

Default value : 'Cancel'

class

Class of the widget.

Type : string

defaultstep

This property allows users to set default step on load of wizard.

Allowed Values: none, [wizardstep[, wizardstep ...]]

none: By default first step is shown

wizardstep: Wizardstep with the name is set as selected step

Type : string

Default value : 'none'

donebtnlabel

This property defines the caption for Done step.

Bindable: true

Type : string

Default value : 'Done'

horizontalalign

This property specifies how the elements should be aligned horizontally.

Allowed Values: left, center, right

left: Aligns an element to the left.

center: Aligns an element to the center.

right: Aligns an element to the right.

Type : string

name

Name of the wizard widget.

Type : string

nextbtnlabel

This property defines the caption for Next step.

Bindable: true

Type : string

Default value : 'next'

previousbtnlabel

This property defines the caption for Previous step.

Bindable: true

Type : string

Default value : 'Previous'

show

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

Bindable: true

Type : boolean

Default value : true

stepstyle

This property sets style on to the step title.

Allowed Values: auto, justified

auto: Step titles will occupy required space.

justified: Step titles will be occupying full space.

Type : string

Default value : 'justified'

result-matching ""

    No results matching ""