Home Reference Source
import FormComponent from 'formiojs/src/components/form/Form.js'
public class | source

FormComponent

Extends:

src/components/_classes/component/Component.js~Component → FormComponent

Static Member Summary

Static Public Members
public static get

builderInfo: {"title": string, "icon": string, "group": string, "documentation": string, "weight": number, "schema": *}

Static Method Summary

Static Public Methods
public static

schema(extend: ...*): *

Member Summary

Public Members
public
public get
public set
public get
public
public get
public get
public get

emptyValue: {"data": *}

public get

errors: *

public

formObj: {"display": *, "settings": *, "components": *}

public
public get
public set
public get

ready: *

public get

Determine if the subform should be submitted.

public

subForm: *

public
public
public get

visible: *

public set
Private Members
private
private
private

Method Summary

Public Methods
public

areAllComponentsEmpty(data: *): *

public

asString(value: *): *

public

attach(element: *): *

public

beforePage(next: *): *

Submit the form before the next page is triggered.

public

Submit the form before the whole form is triggered.

public

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

public

checkComponentConditions(data: *, flags: *, row: *): *

public

checkComponentValidity(data: *, dirty: *, row: *): *

public
public

Create a subform instance.

public
public
public

detach()

public

everyComponent(args: *): * | void

Pass everyComponent to subform.

public

getComponent(path: *, fn: *): *

public

Returns the data for the subform.

public

getSubOptions(options: {}): *

public

getValue(): *

public

Prints out the value of form components as a datagrid value.

public

init(): *

public

isEmpty(value: *): *

public

isHidden(): *

public
public

Load the subform.

public

redraw(): *

public

render(): *

public

setPristine(pristine: *)

public

setValue(submission: *, flags: {}): *

public

submitSubForm(rejectOnError: *): *

Submit the subform if configured to do so.

public

Static Public Members

public static get builderInfo: {"title": string, "icon": string, "group": string, "documentation": string, "weight": number, "schema": *} source

Static Public Methods

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

Params:

NameTypeAttributeDescription
extend ...*

Return:

*

Public Members

public componentModal: * source

public get currentForm: * source

public set currentForm source

public get dataReady: * source

public dataValue: * source

public get defaultSchema: * source

public get defaultValue: * source

public get emptyValue: {"data": *} source

public get errors: * source

public formObj: {"display": *, "settings": *, "components": *} source

public formSrc: string source

public get parentVisible: * source

public set parentVisible source

public get ready: * source

public get shouldSubmit: * | boolean: * source

Determine if the subform should be submitted.

Return:

* | boolean

public subForm: * source

public subFormReady: * source

public valueChanged: boolean source

public get visible: * source

public set visible source

Private Members

private _currentForm: * source

private _parentVisible: * source

private _visible: * source

Public Methods

public areAllComponentsEmpty(data: *): * source

Params:

NameTypeAttributeDescription
data *

Return:

*

public asString(value: *): * source

Params:

NameTypeAttributeDescription
value *

Return:

*

public attach(element: *): * source

Params:

NameTypeAttributeDescription
element *

Return:

*

public beforePage(next: *): * source

Submit the form before the next page is triggered.

Params:

NameTypeAttributeDescription
next *

Return:

*

public beforeSubmit(): * source

Submit the form before the whole form is triggered.

Return:

*

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

Params:

NameTypeAttributeDescription
data *
flags *
row *

Return:

*

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

Params:

NameTypeAttributeDescription
data *
flags *
row *

Return:

*

public checkComponentValidity(data: *, dirty: *, row: *): * source

Params:

NameTypeAttributeDescription
data *
dirty *
row *

Return:

*

public createEmitter(): * source

Return:

*

public createSubForm(): * source

Create a subform instance.

Return:

*

public deleteValue() source

public destroy() source

public detach() source

public everyComponent(args: *): * | void source

Pass everyComponent to subform.

Params:

NameTypeAttributeDescription
args *

Return:

* | void

public getComponent(path: *, fn: *): * source

Params:

NameTypeAttributeDescription
path *
fn *

Return:

*

public getSubFormData(): * source

Returns the data for the subform.

Return:

*

public getSubOptions(options: {}): * source

Params:

NameTypeAttributeDescription
options {}
  • optional
  • default: {}

Return:

*

public getValue(): * source

Return:

*

public getValueAsString(value: *): string source

Prints out the value of form components as a datagrid value.

Params:

NameTypeAttributeDescription
value *

Return:

string

public init(): * source

Return:

*

public isEmpty(value: *): * source

Params:

NameTypeAttributeDescription
value *
  • optional

Return:

*

public isHidden(): * source

Return:

*

public isInternalEvent(event: *): boolean source

Params:

NameTypeAttributeDescription
event *

Return:

boolean

public loadSubForm(): * source

Load the subform.

Return:

*

public redraw(): * source

Return:

*

public render(): * source

Return:

*

public setPristine(pristine: *) source

Params:

NameTypeAttributeDescription
pristine *

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

Params:

NameTypeAttributeDescription
submission *
flags {}
  • optional
  • default: {}

Return:

*

public submitSubForm(rejectOnError: *): * source

Submit the subform if configured to do so.

Params:

NameTypeAttributeDescription
rejectOnError *

Return:

*

public updateSubFormVisibility() source