import NestedComponent from 'formiojs/src/components/_classes/nested/NestedComponent.js'

public class | source

NestedComponent

Extends:

src/components/_classes/component/Component.js~Component → Field → NestedComponent

Direct Subclass:

ColumnsComponent, FieldsetComponent, TableComponent, TabsComponent, TreeComponent, WellComponent

Static Method Summary

Static Public Methods
public static	schema(extend: ...):

Constructor Summary

Public Constructor
public	constructor()

Member Summary

Public Members
public get	collapsed: *
public set	collapsed
public get	componentComponents: *
public	components: *
public get	currentForm: *
public set	currentForm
public get	data: *
public set	data
public get	dataReady: *
public	dataValue: *
public get	defaultSchema: *
public get	disabled: *
public set	disabled
public	error: string
public get	errors: *
public get	isDirty: *
public get	isPristine: *
public get	nestedKey: string
public set	parentDisabled
public get	parentDisabled: *
public set	parentVisible
public get	parentVisible: *
public get	ready: *
public get	rowIndex: *
public set	rowIndex
public get	schema: *
public get	templateName: string
public	type: string
public set	visible
public get	visible: *

Private Members
private	_collapsed: *
private	_data: *
private	_rowIndex: *
private	_visible: *

Method Summary

Public Methods
public	addComponent(component: Object, data: Object, before: HTMLElement): Component Add a new component to the components array.
public	addComponents(element: , data: )
public	attach(element: ):
public	attachComponents(element: , components: , container: ):
public	beforeFocus()
public	beforePage(next: ): Allow components to hook into the next page trigger to perform their own logic.
public	beforeSubmit(): * Allow components to hook into the submission to provide their own async data.
public	calculateComponentPath(component: Object): string Return a path of component's value.
public	calculateValue(data: , flags: , row: ):
public	checkAsyncValidity(data: , dirty: , row: , silentCheck: ): *
public	checkConditions(data: , flags: , row: ):
public	checkData(data: , flags: , row: , components: ): *
public	checkModal(isValid: , dirty: )
public	checkValidity(data: , dirty: , row: , silentCheck: ): *
public	clear()
public	clearOnHide(show: *)
public	componentContext(): *
public	createComponent(component: , data: ): * Create a new component and add it to the components array.
public	destroy()
public	destroyComponents()
public	detach()
public	eachComponent(fn: function) Perform an iteration over each component within this container component.
public	everyComponent(fn: function) Perform a deep iteration over every component, including those within other container based components.
public	flattenComponents(): *
public	getComponent(key: string, fn: function): Object Returns a component provided a key.
public	getComponentById(id: string, fn: function): Object Return a component provided the Id of the component.
public	getComponents(): *
public	getContainer(): *
public	getValue(): *
public	hasComponent(component: ):
public	init(): *
public	isLastPage(): *
public	isValid(data: , dirty: ): *
public	removeComponent(component: Component, components: Array<Component>) Remove a component from the components array.
public	removeComponentById(id: string, fn: function): null Removes a component provided the Id of the component.
public	removeComponentByKey(key: string, fn: function): null Removes a component provided the API key of that component.
public	render(children: ):
public	renderComponents(components: ):
public	resetValue()
public	restoreComponentsContext()
public	setNestedValue(component: , value: , flags: {}): *
public	setPristine(pristine: *)
public	setValue(value: , flags: {}):
public	shouldSkipValidation(data: , dirty: , row: ):
public	updateValue(value: , flags: {}):

Inherited Summary

From class Field
public	render(element: ):

Static Public Methods

public static schema(extend: ...): source

Params:

Name	Type	Attribute	Description
extend	...*

Return:

Public Constructors

public constructor() source

Public Members

public get collapsed: * source

public set collapsed source

public get componentComponents: * source

public components: * source

public get currentForm: * source

public set currentForm source

public get data: * source

public set data source

public get dataReady: * source

public dataValue: * source

public get defaultSchema: * source

public get disabled: * source

public set disabled source

public error: string source

public get errors: * source

public get isDirty: * source

public get isPristine: * source

public get nestedKey: string source

public set parentDisabled source

public get parentDisabled: * source

public set parentVisible source

public get parentVisible: * source

public get ready: * source

public get rowIndex: * source

public set rowIndex source

public get schema: * source

public get templateName: string source

public type: string source

public set visible source

public get visible: * source

Private Members

private _collapsed: * source

private _data: * source

private _rowIndex: * source

private _visible: * source

Public Methods

public addComponent(component: Object, data: Object, before: HTMLElement): Component source

Add a new component to the components array.

Params:

Name	Type	Attribute	Description
component	Object		The component JSON schema to add.
data	Object		The submission data object to house the data for this component.
before	HTMLElement		A DOM element to insert this element before.

Return:

Component

The created component instance.

public addComponents(element: , data: ) source

Params:

Name	Type	Attribute	Description
element	*
data	*

public attach(element: ): source

Params:

Name	Type	Attribute	Description
element	*

Return:

public attachComponents(element: , components: , container: ): source

Params:

Name	Type	Attribute	Description
element	*
components	*
container	*

Return:

public beforeFocus() source

public beforePage(next: ): source

Allow components to hook into the next page trigger to perform their own logic.

Params:

Name	Type	Attribute	Description
next	*

Return:

public beforeSubmit(): * source

Allow components to hook into the submission to provide their own async data.

Return:

public calculateComponentPath(component: Object): string source

Return a path of component's value.

Params:

Name	Type	Attribute	Description
component	Object		The component instance.

Return:

string

The component's value path.

public calculateValue(data: , flags: , row: ): source

Params:

Name	Type	Attribute	Description
data	*
flags	*
row	*

Return:

public checkAsyncValidity(data: , dirty: , row: , silentCheck: ): * source

Params:

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

Return:

public checkConditions(data: , flags: , row: ): source

Params:

Name	Type	Attribute	Description
data	*
flags	*
row	*

Return:

public checkData(data: , flags: , row: , components: ): * source

Params:

Name	Type	Attribute	Description
data	*
flags	*
row	*
components	*

Return:

public checkModal(isValid: , dirty: ) source

Params:

Name	Type	Attribute	Description
isValid	*
dirty	*

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

Params:

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

Return:

public clear() source

public clearOnHide(show: *) source

Params:

Name	Type	Attribute	Description
show	*

public componentContext(): * source

Return:

public createComponent(component: , data: ): * source

Create a new component and add it to the components array.

Params:

Name	Type	Attribute	Description
component	*
data	*

Return:

public destroy() source

public destroyComponents() source

public detach() source

public eachComponent(fn: function) source

Perform an iteration over each component within this container component.

Params:

Name	Type	Attribute	Description
fn	function		Called for each component

public everyComponent(fn: function) source

Perform a deep iteration over every component, including those within other container based components.

Params:

Name	Type	Attribute	Description
fn	function		Called for every component.

public flattenComponents(): * source

Return:

public getComponent(key: string, fn: function): Object source

Returns a component provided a key. This performs a deep search within the component tree.

Params:

Name	Type	Attribute	Description
key	string		The key of the component to retrieve.
fn	function		Called with the component once found.

Return:

Object

The component that is located.

public getComponentById(id: string, fn: function): Object source

Return a component provided the Id of the component.

Params:

Name	Type	Attribute	Description
id	string		The Id of the component.
fn	function		Called with the component once it is retrieved.

Return:

Object

The component retrieved.

public getComponents(): * source

Return:

public getContainer(): * source

Return:

public getValue(): * source

Return:

public hasComponent(component: ): source

Params:

Name	Type	Attribute	Description
component	*

Return:

public init(): * source

Return:

public isLastPage(): * source

Return:

public isValid(data: , dirty: ): * source

Params:

Name	Type	Attribute	Description
data	*
dirty	*

Return:

public removeComponent(component: Component, components: Array<Component>) source

Remove a component from the components array.

Params:

Name	Type	Attribute	Description
component	Component		The component to remove from the components.
components	Array<Component>		An array of components to remove this component from.

public removeComponentById(id: string, fn: function): null source

Removes a component provided the Id of the component.

Params:

Name	Type	Attribute	Description
id	string		The Id of the component to remove.
fn	function		Called when the component is removed.

Return:

null

public removeComponentByKey(key: string, fn: function): null source

Removes a component provided the API key of that component.

Params:

Name	Type	Attribute	Description
key	string		The API key of the component to remove.
fn	function		Called once the component is removed.

Return:

null

public render(children: ): source

Override:

Field#render

Params:

Name	Type	Attribute	Description
children	*

Return:

public renderComponents(components: ): source

Params:

Name	Type	Attribute	Description
components	*

Return:

public resetValue() source

public restoreComponentsContext() source

public setNestedValue(component: , value: , flags: {}): * source

Params:

Name	Type	Attribute	Description
component	*
value	*
flags	{}	optional default: {}

Return:

public setPristine(pristine: *) source

Params:

Name	Type	Attribute	Description
pristine	*

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

Params:

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

Return:

public shouldSkipValidation(data: , dirty: , row: ): source

Params:

Name	Type	Attribute	Description
data	*
dirty	*
row	*

Return:

public updateValue(value: , flags: {}): source

Params:

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

NestedComponent

Extends:

Direct Subclass:

Static Method Summary

Constructor Summary

Member Summary

Method Summary

Inherited Summary

Static Public Methods

public static schema(extend: ...*): * source

Params:

Return:

Public Constructors

public constructor() source

Public Members

public get collapsed: * source

public set collapsed source

public get componentComponents: * source

public components: * source

public get currentForm: * source

public set currentForm source

public get data: * source

public set data source

public get dataReady: * source

public dataValue: * source

public get defaultSchema: * source

public get disabled: * source

public set disabled source

public error: string source

public get errors: * source

public get isDirty: * source

public get isPristine: * source

public get nestedKey: string source

public set parentDisabled source

public get parentDisabled: * source

public set parentVisible source

public get parentVisible: * source

public get ready: * source

public get rowIndex: * source

public set rowIndex source

public get schema: * source

public get templateName: string source

public type: string source

public set visible source

public get visible: * source

Private Members

private _collapsed: * source

private _data: * source

private _rowIndex: * source

private _visible: * source

Public Methods

public addComponent(component: Object, data: Object, before: HTMLElement): Component source

Params:

Return:

public addComponents(element: *, data: *) source

Params:

public attach(element: *): * source

Params:

Return:

public attachComponents(element: *, components: *, container: *): * source

Params:

Return:

public beforeFocus() source

public beforePage(next: *): * source

Params:

Return:

public beforeSubmit(): * source

Return:

public calculateComponentPath(component: Object): string source

Params:

Return:

public calculateValue(data: *, flags: *, row: *): * source

Params:

Return:

public checkAsyncValidity(data: *, dirty: *, row: *, silentCheck: *): * source

Params:

Return:

public checkConditions(data: *, flags: *, row: *): * source

Params:

Return:

public static schema(extend: ...): source

public addComponents(element: , data: ) source

public attach(element: ): source

public attachComponents(element: , components: , container: ): source

public beforePage(next: ): source

public calculateValue(data: , flags: , row: ): source

public checkAsyncValidity(data: , dirty: , row: , silentCheck: ): * source

public checkConditions(data: , flags: , row: ): source

public checkData(data: , flags: , row: , components: ): * source

public checkModal(isValid: , dirty: ) source

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

public createComponent(component: , data: ): * source

public hasComponent(component: ): source

public isValid(data: , dirty: ): * source

public render(children: ): source

public renderComponents(components: ): source

public setNestedValue(component: , value: , flags: {}): * source

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