File

projects/components/widgets/containers/wizard/src/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
Type : string
Default value : 'right'

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

cancelable
Type : boolean
Default value : true

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

Bindable: true

cancelbtnlabel
Type : string
Default value : 'Cancel'

This property defines the caption for Cancel step.

Bindable: true

class
Type : string

Class of the widget.

defaultstep
Type : string
Default value : 'none'

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

donebtnlabel
Type : string
Default value : 'Done'

This property defines the caption for Done step.

Bindable: true

horizontalalign
Type : string

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.

name
Type : string

Name of the wizard widget.

nextbtnlabel
Type : string
Default value : 'next'

This property defines the caption for Next step.

Bindable: true

previousbtnlabel
Type : string
Default value : 'Previous'

This property defines the caption for Previous step.

Bindable: true

show
Type : boolean
Default value : true

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

Bindable: true

stepstyle
Type : string
Default value : 'justified'

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.

result-matching ""

    No results matching ""