import FormioWizard from 'formiojs/src/formio.wizard.js'

public class | source

FormioWizard

Extends:

src/formio.form~FormioForm → FormioWizard

Constructor Summary

Public Constructor
public	constructor(element: *, options: Object) Constructor for wizard based forms

Member Summary

Public Members
public	globalComponents: *[]
public	history: *[]
public	page: number
public	pages: *[]
public get	schema: *
public	wizard: *
public	wizardHeader: *
public	wizardHeaderList: *
public	wizardNav: *

Private Members
private	_nextPage: number

Method Summary

Public Methods
public	addGlobalComponents(page: ):
public	beforeSubmit(): *
public	build()
public	buildPages(form: *)
public	buildWizardHeader()
public	buildWizardNav(nextPage: *)
public	cancel(noconfirm: ):
public	currentPage(): *
public	getNextPage(data: , currentPage: ): *
public	getPage(pageNum: ):
public	getPageIndexByKey(key: ):
public	getPreviousPage(): *
public	getWizard(): *
public	hasButton(name: , nextPage: ): boolean
public	nextPage(): *
public	onChange(flags: , changed: )
public	pageId(page: ):
public	prevPage(): *
public	setForm(form: ):
public	setPage(num: ):

Public Constructors

public constructor(element: *, options: Object) source

Constructor for wizard based forms

Params:

Name	Type	Attribute	Description
element	*		Dom element to place this wizard.
options	Object		Options object, supported options are: breadcrumbSettings.clickable: true (default) determines if the breadcrumb bar is clickable or not buttonSettings.show*(Previous, Next, Cancel): true (default) determines if the button is shown or not

Name

Type

Attribute

Description

element

Dom element to place this wizard.

options

Object

Options object, supported options are:

breadcrumbSettings.clickable: true (default) determines if the breadcrumb bar is clickable or not
buttonSettings.show*(Previous, Next, Cancel): true (default) determines if the button is shown or not

Public Members

public globalComponents: *[] source

public history: *[] source

public page: number source

public pages: *[] source

public get schema: * source

public wizard: * source

public wizardHeader: * source

public wizardHeaderList: * source

public wizardNav: * source

Private Members

private _nextPage: number source

Public Methods

public addGlobalComponents(page: ): source

Params:

Name	Type	Attribute	Description
page	*

Return:

public beforeSubmit(): * source

Return:

public build() source

public buildPages(form: *) source

Params:

Name	Type	Attribute	Description
form	*

public buildWizardHeader() source

public buildWizardNav(nextPage: *) source

Params:

Name	Type	Attribute	Description
nextPage	*

public cancel(noconfirm: ): source

Params:

Name	Type	Attribute	Description
noconfirm	*

Return:

public currentPage(): * source

Return:

public getNextPage(data: , currentPage: ): * source

Params:

Name	Type	Attribute	Description
data	*
currentPage	*

Return:

public getPage(pageNum: ): source

Params:

Name	Type	Attribute	Description
pageNum	*

Return:

public getPageIndexByKey(key: ): source

Params:

Name	Type	Attribute	Description
key	*

Return:

public getPreviousPage(): * source

Return:

public getWizard(): * source

Return:

public hasButton(name: , nextPage: ): boolean source

Params:

Name	Type	Attribute	Description
name	*
nextPage	*

Return:

boolean

public nextPage(): * source

Return:

public onChange(flags: , changed: ) source

Params:

Name	Type	Attribute	Description
flags	*
changed	*

public pageId(page: ): source

Params:

Name	Type	Attribute	Description
page	*

Return:

public prevPage(): * source

Return:

public setForm(form: ): source

Params:

Name	Type	Attribute	Description
form	*

Return:

public setPage(num: ): source

Params:

Name	Type	Attribute	Description
num	*

FormioWizard

Extends:

Constructor Summary

Member Summary

Method Summary

Public Constructors

public constructor(element: *, options: Object) source

Params:

Public Members

public globalComponents: *[] source

public history: *[] source

public page: number source

public pages: *[] source

public get schema: * source

public wizard: * source

public wizardHeader: * source

public wizardHeaderList: * source

public wizardNav: * source

Private Members

private _nextPage: number source

Public Methods

public addGlobalComponents(page: *): * source

Params:

Return:

public beforeSubmit(): * source

Return:

public build() source

public buildPages(form: *) source

Params:

public buildWizardHeader() source

public buildWizardNav(nextPage: *) source

Params:

public cancel(noconfirm: *): * source

Params:

Return:

public currentPage(): * source

Return:

public getNextPage(data: *, currentPage: *): * source

Params:

Return:

public getPage(pageNum: *): * source

Params:

Return:

public getPageIndexByKey(key: *): * source

Params:

Return:

public getPreviousPage(): * source

Return:

public getWizard(): * source

Return:

public hasButton(name: *, nextPage: *): boolean source

Params:

Return:

public nextPage(): * source

Return:

public onChange(flags: *, changed: *) source

Params:

public pageId(page: *): * source

Params:

Return:

public prevPage(): * source

Return:

public setForm(form: *): * source

Params:

Return:

public setPage(num: *): * source

Params:

Return:

public addGlobalComponents(page: ): source

public cancel(noconfirm: ): source

public getNextPage(data: , currentPage: ): * source

public getPage(pageNum: ): source

public getPageIndexByKey(key: ): source

public hasButton(name: , nextPage: ): boolean source

public onChange(flags: , changed: ) source

public pageId(page: ): source

public setForm(form: ): source

public setPage(num: ): source