import Wizard from 'formiojs/src/Wizard.js'

public class | source

Wizard

Extends:

src/components/_classes/nesteddata/NestedDataComponent.js~NestedDataComponent → Webform → Wizard

Constructor Summary

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

Member Summary

Public Members
public get	buttons: *
public	component: *
public	components: *[]
public	currentNextPage: number
public get	currentPage: *
public	currentPanel: *
public get	data: *
public set	data
public	disabled: *
public	element: *
public get	errors: *
public get	form: *
public set	form
public	originalComponent: *
public	originalComponents: *[]
public	page: number
public	pages: *[]
public	prefixComps: *[]
public get	renderContext: {"wizardKey": , "isBreadcrumbClickable": , "panels": , "buttons": , "currentPage": *}
public get	schema: *
public	suffixComps: *[]
public	wizard: *
public get	wizardKey: string

Private Members
private	_seenPages: number[]

Method Summary

Public Methods
public	addComponents()
public	attach(element: ):
public	attachHeader()
public	attachNav()
public	beforePage(next: ):
public	beforeSubmit(): *
public	cancel(noconfirm: ):
public	checkValidity(data: , dirty: , row: , currentPageOnly: ): *
public	detachHeader()
public	detachNav()
public	establishPages(data: ):
public	focusOnComponent(key: ):
public	getComponents(): *
public	getNextPage(): *
public	getPageIndexByKey(key: ):
public	getPages(args: {}): *
public	getPreviousPage(): *
public	hasButton(name: , nextPage: ): boolean
public	init(): *
public	isBreadcrumbClickable(): *
public	isClickable(page: , index: ): *
public	isLastPage(): *
public	nextPage(): *
public	onChange(flags: , changed: , modified: , changes: )
public	pageFieldLogic(page: *)
public	pageId(page: ):
public	prepareHeaderSettings(ctx: ):
public	prepareNavigationSettings(ctx: ):
public	prevPage(): *
public	redrawHeader()
public	redrawNavigation()
public	render(): *
public	resetValue()
public	setComponentSchema()
public	setForm(form: , flags: ): *
public	setPage(num: ):
public	setValue(submission: , flags: {}):

Inherited Summary

From class Webform
public get	componentComponents: *
public get	form: Object: * Gets the form object.
public set	form(form: Object) Sets the form value.
public set	language(lang: *): Promise Sets the language for this form.
public get	loading: boolean: * Returns if this form is loading.
public set	loading(loading: boolean) Set the loading state for this form, and also show the loader spinner.
public get	nosubmit: *
public set	nosubmit
public get	ready: Promise: * Called when both the form and submission have been loaded.
public get	schema: *
public get	src: string: * Get the embed source of the form.
public set	src(value: string) Set the Form source, which is typically the Form.io embed URL.
public get	submission: Object: * Returns the submission object that was set within this form.
public set	submission(submission: Object) Sets the submission of a form.
public get	url: string: * Get the embed source of the form.
public set	url(value: string) Set the form source but don't initialize the form and submission from the url.
public	alert: HTMLElement The alert HTML element
public	component: *
public	components: *[]
public	currentForm: *
public	customErrors: *[]
public	draftEnabled: boolean
public	editing: *
public	element: *
public	executeShortcuts: *
public	formReady: Promise Promise that executes when the form is ready and rendered.
public	formReadyReject: function Called when this form could not load and is rejected.
public	formReadyResolve: function Called when the formReady state of this form has been resolved.
public	formio: Formio The Formio instance for this form.
public	initialized: boolean
public	loader: HTMLElement The loader HTML element.
public	loadingSubmission: boolean
public	onSubmission: Promise Promise that is triggered when the submission is done loading.
public	options: *
public	pristine: boolean
public	root: *
public	savingDraft: boolean
public	shortcuts: *[]
public	submissionReady: Promise Promise that executes when the submission is ready and rendered.
public	submissionReadyReject: function Called when this form could not load and is rejected.
public	submissionReadyResolve: function Called when the formReady state of this form has been resolved.
public	submissionSet: boolean Determines if this submission is explicitly set.
public	submitted: boolean Determines if the form has tried to be submitted, error or not.
public	submitting: boolean Determines if the form is being submitted at the moment.
public	triggerSaveDraft: *
public	type: string The type of this element.
private	_form: {}
private	_loading: boolean
private	_nosubmit: *
private	_src: string
private	_submission: *
public	addLanguage(code: , lang: , active: ): Add a language for translations
public	addShortcut(element: , shortcut: )
public	attach(element: ):
public	build(element: ):
public	cancel(noconfirm: *): boolean Cancels the submission.
public	checkData(data: , flags: {}):
public	deleteSubmission(): * Send a delete request to the server.
public	destroy(deleteFromGlobal: boolean): *
public	executeFormController(): boolean
public	executeSubmit(options: ):
public	focusOnComponent(key: string): * Focus on selected component.
public	getClassName(): *
public	getValue(): *
public	hasRequiredFields(): *
public	init(): * Build the form.
public	keyboardCatchableElement(element: *): boolean
public	loadSubmission(): * Loads the submission if applicable.
public	localize(): * Perform the localization initialization.
public	mergeData(_this: , _that: )
public	onChange(changed: , flags: ) Trigger the change event for this form.
public	onSubmissionError(error: Object): * Called when an error occurs during the submission.
public	onSubmit(submission: Object, saved: boolean): object Called when the submission has completed, or if the submission needs to be sent to an external library.
public	redraw(): *
public	removeShortcut(element: , shortcut: )
public	render(): *
public	resetValue()
public	restoreDraft(-: userId) Restores a draft submission based on the user who is authenticated.
public	saveDraft() Saves a submission draft.
public	setAlert(type: string, message: string, classes: string) Sets a new alert to display in the error dialog of the form.
public	setForm(form: Object): * Sets the JSON schema for the form to be rendered.
public	setMetadata(submission: *)
public	setSrc(value: , options: ): * Set the src of the form renderer.
public	setSubmission(submission: , flags: ): Promise<TResult> Sets a submission and returns the promise when it is ready.
public	setUrl(value: , options: ): boolean Sets the url of the form renderer.
public	setValue(submission: , flags: {}):
public	showErrors(error: Object): * Show the errors of this form within the alert dialog.
public	submit(before: boolean): Promise Submits the form.
public	submitForm(options: {}): *
public	submitUrl(URL: , headers: ): *
public	triggerRecaptcha()

Public Constructors

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

Constructor for wizard based forms

Override:

Webform#constructor

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 get buttons: * source

public component: * source

Override:

Webform#component

public components: *[] source

Override:

Webform#components

public currentNextPage: number source

public get currentPage: * source

public currentPanel: * source

public get data: * source

public set data source

public disabled: * source

public element: * source

Override:

Webform#element

public get errors: * source

public get form: * source

Gets the form object.

Override:

Webform#form

public set form source

Gets the form object.

Override:

Webform#form

public originalComponent: * source

public originalComponents: *[] source

public page: number source

public pages: *[] source

public prefixComps: *[] source

public get renderContext: {"wizardKey": , "isBreadcrumbClickable": , "panels": , "buttons": , "currentPage": *} source

public get schema: * source

Override:

Webform#schema

public suffixComps: *[] source

public wizard: * source

public get wizardKey: string source

Private Members

private _seenPages: number[] source

Public Methods

public addComponents() source

public attach(element: ): source

Override:

Webform#attach

Params:

Name	Type	Attribute	Description
element	*

Return:

public attachHeader() source

public attachNav() source

public beforePage(next: ): source

Params:

Name	Type	Attribute	Description
next	*

Return:

public beforeSubmit(): * source

Return:

public cancel(noconfirm: ): source

Cancels the submission.

Override:

Webform#cancel

Params:

Name	Type	Attribute	Description
noconfirm	*

Return:

public checkValidity(data: , dirty: , row: , currentPageOnly: ): * source

Params:

Name	Type	Attribute	Description
data	*
dirty	*
row	*
currentPageOnly	*

Return:

public detachHeader() source

public detachNav() source

public establishPages(data: ): source

Params:

Name	Type	Attribute	Description
data	*	optional

Return:

public focusOnComponent(key: ): source

Focus on selected component.

Override:

Webform#focusOnComponent

Params:

Name	Type	Attribute	Description
key	*

Return:

public getComponents(): * source

Return:

public getNextPage(): * source

Return:

public getPageIndexByKey(key: ): source

Params:

Name	Type	Attribute	Description
key	*

Return:

public getPages(args: {}): * source

Params:

Name	Type	Attribute	Description
args	{}	optional default: {}

Return:

public getPreviousPage(): * source

Return:

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

Params:

Name	Type	Attribute	Description
name	*
nextPage	*	optional

Return:

boolean

public init(): * source

Build the form.

Override:

Webform#init

Return:

public isBreadcrumbClickable(): * source

Return:

public isClickable(page: , index: ): * source

Params:

Name	Type	Attribute	Description
page	*
index	*

Return:

public isLastPage(): * source

Return:

public nextPage(): * source

Return:

public onChange(flags: , changed: , modified: , changes: ) source

Trigger the change event for this form.

Override:

Webform#onChange

Params:

Name	Type	Attribute	Description
flags	*
changed	*
modified	*
changes	*

public pageFieldLogic(page: *) source

Params:

Name	Type	Attribute	Description
page	*

public pageId(page: ): source

Params:

Name	Type	Attribute	Description
page	*

Return:

public prepareHeaderSettings(ctx: ): source

Params:

Name	Type	Attribute	Description
ctx	*

Return:

public prepareNavigationSettings(ctx: ): source

Params:

Name	Type	Attribute	Description
ctx	*

Return:

public prevPage(): * source

Return:

public redrawHeader() source

public redrawNavigation() source

public render(): * source

Override:

Webform#render

Return:

public resetValue() source

Override:

Webform#resetValue

public setComponentSchema() source

public setForm(form: , flags: ): * source

Sets the JSON schema for the form to be rendered.

Override:

Webform#setForm

Params:

Name	Type	Attribute	Description
form	*
flags	*

Return:

public setPage(num: ): source

Params:

Name	Type	Attribute	Description
num	*

Return:

public setValue(submission: , flags: {}): source

Override:

Webform#setValue

Params:

Name	Type	Attribute	Description
submission	*
flags	{}	optional default: {}

Wizard

Extends:

Constructor Summary

Member Summary

Method Summary

Inherited Summary

Public Constructors

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

Override:

Params:

Public Members

public get buttons: * source

public component: * source

Override:

public components: *[] source

Override:

public currentNextPage: number source

public get currentPage: * source

public currentPanel: * source

public get data: * source

public set data source

public disabled: * source

public element: * source

Override:

public get errors: * source

public get form: * source

Override:

public set form source

Override:

public originalComponent: * source

public originalComponents: *[] source

public page: number source

public pages: *[] source

public prefixComps: *[] source

public get renderContext: {"wizardKey": *, "isBreadcrumbClickable": *, "panels": *, "buttons": *, "currentPage": *} source

public get schema: * source

Override:

public suffixComps: *[] source

public wizard: * source

public get wizardKey: string source

Private Members

private _seenPages: number[] source

Public Methods

public addComponents() source

public attach(element: *): * source

Override:

Params:

Return:

public attachHeader() source

public attachNav() source

public beforePage(next: *): * source

Params:

Return:

public beforeSubmit(): * source

Return:

public cancel(noconfirm: *): * source

Override:

Params:

Return:

public checkValidity(data: *, dirty: *, row: *, currentPageOnly: *): * source

Params:

Return:

public detachHeader() source

public detachNav() source

public establishPages(data: *): * source

Params:

Return:

public focusOnComponent(key: *): * source

Override:

Params:

Return:

public getComponents(): * source

Return:

public getNextPage(): * source

Return:

public getPageIndexByKey(key: *): * source

Params:

Return:

public getPages(args: {}): * source

Params:

public get renderContext: {"wizardKey": , "isBreadcrumbClickable": , "panels": , "buttons": , "currentPage": *} source

public attach(element: ): source

public beforePage(next: ): source

public cancel(noconfirm: ): source

public checkValidity(data: , dirty: , row: , currentPageOnly: ): * source

public establishPages(data: ): source

public focusOnComponent(key: ): source

public getPageIndexByKey(key: ): source

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

public isClickable(page: , index: ): * source

public onChange(flags: , changed: , modified: , changes: ) source

public pageId(page: ): source

public prepareHeaderSettings(ctx: ): source

public prepareNavigationSettings(ctx: ): source

public setForm(form: , flags: ): * source

public setPage(num: ): source

public setValue(submission: , flags: {}): source