Home Reference Source

Function

Static Public Summary
public

Address(extend: ...*): *

public

Button(extend: ...*): *

public

Checkbox(extend: ...*): *

public

Columns(extend: ...*): *

public

Component(extend: ...*): {"components": *}

public

Container(extend: ...*): *

public

Content(extend: ...*): *

public

Currency(extend: ...*): *

public

DataGrid(extend: ...*): *

public

DataMap(extend: ...*): *

public

DateTime(extend: ...*): *

public

Day(extend: ...*): *

public

EditGrid(extend: ...*): *

public

EditTable(extend: ...*): *

public

Email(extend: ...*): *

public

Fieldset(extend: ...*): *

public

File(extend: ...*): *

public

Form(extend: ...*): *

public

HTML(extend: ...*): *

public

Hidden(extend: ...*): *

public

Location(extend: ...*): *

public

ModalEdit(extend: ...*): *

public

NestedComponent(extend: ...*): *

public

Number(extend: ...*): *

public

Panel(extend: ...*): *

public

Password(extend: ...*): *

public

PhoneNumber(extend: ...*): *

public

Radio(extend: ...*): *

public

ReCaptcha(): *

public

Resource(extend: ...*): *

public

Select(extend: ...*): *

public

SelectBoxes(extend: ...*): *

public

Signature(extend: ...*): *

public

Survey(extend: ...*): *

public

Table(extend: ...*): *

public

Tabs(extend: ...*): *

public

Tags(extend: ...*): *

public

TextArea(extend: ...*): *

public

TextField(extend: ...*): *

public

Time(extend: ...*): *

public

Tree(extend: ...*): *

public

Unknown(): {"components": *}

public

Url(extend: ...*): *

public

Well(extend: ...*): *

public

applyFormChanges(form: *, changes: *): {"form": *, "failed": *}

public

azure(formio: *): *

public

base64(): *

public

checkInvalidDate(value: String, format: [String], maxDate: Date, minDate: Date): *

Checks the entered date for validity.

public

dropbox(formio: *): *

public

eachComponent(components: Object, fn: Function, includeAll: Boolean, path: String, parent: Object)

Iterate through each component within a form.

public

embed(config: {})

public

Escapes RegEx characters in provided String value.

public

fileProcessor(formio: *, config: *)

public

findComponent(components: *, key: *, fn: *, path: *): *

This function will find a component in a form and return the component AND THE PATH to the component in the form.

public

findComponents(components: *, query: *): *

Deprecated version of findComponents.

public

flattenComponents(components: Object, includeAll: Boolean): Object

Flatten the form components for data manipulation.

public

formatAsCurrency(value: any): String

Formats provided value in way how Currency component uses it.

public

generateFormChange(type: *, data: *): *

public

getComponent(components: Object, key: String | Object): Object

Get a component by its key

public

getFormioUploadAdapterPlugin(fileService: *, component: *)

public

getStrings(form: *): *

Iterate over all components in a form and get string values for translation.

public

getValue(submission: Object, key: String): *

Get the value for a component key, in the given submission.

public

googledrive(formio: *): *

public

hasCondition(component: *): boolean

Returns if this component has a conditional statement.

public

iconClass(iconset: *, name: *, spinning: *): *

public

indexeddb(): *

public

Determine if a component is a layout component or not.

public

lessOrGreater(value: moment, format: [String], maxDate: Date, minDate: Date): {"message": *, "result": *}

Checks the value for a min date and max date.

public

matchComponent(component: *, query: *): boolean

Matches if a component matches the query.

public

parseFloatExt(value: any): Number

Extension of standard #parseFloat(value) function, that also clears input string.

public

removeComponent(components: *, path: *)

Remove a component by path.

public

s3(formio: *): *

public

searchComponents(components: *, query: *): *

Finds a component provided a query of properties of that component.

public

setXhrHeaders(formio: *, xhr: *)

public

url(formio: *): *

Static Public

public Address(extend: ...*): * source

Params:

NameTypeAttributeDescription
extend ...*

Return:

*

public Button(extend: ...*): * source

Params:

NameTypeAttributeDescription
extend ...*

Return:

*

public Checkbox(extend: ...*): * source

Params:

NameTypeAttributeDescription
extend ...*

Return:

*

public Columns(extend: ...*): * source

Params:

NameTypeAttributeDescription
extend ...*

Return:

*

public Component(extend: ...*): {"components": *} source

Params:

NameTypeAttributeDescription
extend ...*

Return:

{"components": *}

public Container(extend: ...*): * source

Params:

NameTypeAttributeDescription
extend ...*

Return:

*

public Content(extend: ...*): * source

Params:

NameTypeAttributeDescription
extend ...*

Return:

*

public Currency(extend: ...*): * source

Params:

NameTypeAttributeDescription
extend ...*

Return:

*

public DataGrid(extend: ...*): * source

Params:

NameTypeAttributeDescription
extend ...*

Return:

*

public DataMap(extend: ...*): * source

Params:

NameTypeAttributeDescription
extend ...*

Return:

*

public DateTime(extend: ...*): * source

Params:

NameTypeAttributeDescription
extend ...*

Return:

*

public Day(extend: ...*): * source

Params:

NameTypeAttributeDescription
extend ...*

Return:

*

public EditGrid(extend: ...*): * source

Params:

NameTypeAttributeDescription
extend ...*

Return:

*

public EditTable(extend: ...*): * source

Params:

NameTypeAttributeDescription
extend ...*

Return:

*

public Email(extend: ...*): * source

Params:

NameTypeAttributeDescription
extend ...*

Return:

*

public Fieldset(extend: ...*): * source

Params:

NameTypeAttributeDescription
extend ...*

Return:

*

public File(extend: ...*): * source

Params:

NameTypeAttributeDescription
extend ...*

Return:

*

public Form(extend: ...*): * source

Params:

NameTypeAttributeDescription
extend ...*

Return:

*

public HTML(extend: ...*): * source

Params:

NameTypeAttributeDescription
extend ...*

Return:

*

public Hidden(extend: ...*): * source

Params:

NameTypeAttributeDescription
extend ...*

Return:

*

public Location(extend: ...*): * source

Params:

NameTypeAttributeDescription
extend ...*

Return:

*

public ModalEdit(extend: ...*): * source

Params:

NameTypeAttributeDescription
extend ...*

Return:

*

public NestedComponent(extend: ...*): * source

Params:

NameTypeAttributeDescription
extend ...*

Return:

*

public Number(extend: ...*): * source

Params:

NameTypeAttributeDescription
extend ...*

Return:

*

public Panel(extend: ...*): * source

Params:

NameTypeAttributeDescription
extend ...*

Return:

*

public Password(extend: ...*): * source

Params:

NameTypeAttributeDescription
extend ...*

Return:

*

public PhoneNumber(extend: ...*): * source

Params:

NameTypeAttributeDescription
extend ...*

Return:

*

public Radio(extend: ...*): * source

Params:

NameTypeAttributeDescription
extend ...*

Return:

*

public ReCaptcha(): * source

Return:

*

public Resource(extend: ...*): * source

Params:

NameTypeAttributeDescription
extend ...*

Return:

*

public Select(extend: ...*): * source

Params:

NameTypeAttributeDescription
extend ...*

Return:

*

public SelectBoxes(extend: ...*): * source

Params:

NameTypeAttributeDescription
extend ...*

Return:

*

public Signature(extend: ...*): * source

Params:

NameTypeAttributeDescription
extend ...*

Return:

*

public Survey(extend: ...*): * source

Params:

NameTypeAttributeDescription
extend ...*

Return:

*

public Table(extend: ...*): * source

Params:

NameTypeAttributeDescription
extend ...*

Return:

*

public Tabs(extend: ...*): * source

Params:

NameTypeAttributeDescription
extend ...*

Return:

*

public Tags(extend: ...*): * source

Params:

NameTypeAttributeDescription
extend ...*

Return:

*

public TextArea(extend: ...*): * source

Params:

NameTypeAttributeDescription
extend ...*

Return:

*

public TextField(extend: ...*): * source

Params:

NameTypeAttributeDescription
extend ...*

Return:

*

public Time(extend: ...*): * source

Params:

NameTypeAttributeDescription
extend ...*

Return:

*

public Tree(extend: ...*): * source

Params:

NameTypeAttributeDescription
extend ...*

Return:

*

public Unknown(): {"components": *} source

Return:

{"components": *}

public Url(extend: ...*): * source

Params:

NameTypeAttributeDescription
extend ...*

Return:

*

public Well(extend: ...*): * source

Params:

NameTypeAttributeDescription
extend ...*

Return:

*

public applyFormChanges(form: *, changes: *): {"form": *, "failed": *} source

import {applyFormChanges} from 'formiojs/src/utils/formUtils.js'

Params:

NameTypeAttributeDescription
form *
changes *

Return:

{"form": *, "failed": *}

public azure(formio: *): * source

Params:

NameTypeAttributeDescription
formio *

Return:

*

public base64(): * source

Return:

*

public checkInvalidDate(value: String, format: [String], maxDate: Date, minDate: Date): * source

import {checkInvalidDate} from 'formiojs/src/utils/calendarUtils.js'

Checks the entered date for validity.

Params:

NameTypeAttributeDescription
value String

The value to check.

format [String]

A moment formats.

maxDate Date

The max date.

minDate Date

The min date.

  • @return {{message: string, result: boolean}}

Return:

*

public dropbox(formio: *): * source

Params:

NameTypeAttributeDescription
formio *

Return:

*

public eachComponent(components: Object, fn: Function, includeAll: Boolean, path: String, parent: Object) source

import {eachComponent} from 'formiojs/src/utils/formUtils.js'

Iterate through each component within a form.

Params:

NameTypeAttributeDescription
components Object

The components to iterate.

fn Function

The iteration function to invoke for each component.

includeAll Boolean

Whether or not to include layout components.

path String

The current data path of the element. Example: data.user.firstName

parent Object

The parent object.

public embed(config: {}) source

import {embed} from 'formiojs/src/Embed.js'

Params:

NameTypeAttributeDescription
config {}
  • optional
  • default: {}

public escapeRegExCharacters(value: String): string source

import {escapeRegExCharacters} from 'formiojs/src/utils/formUtils.js'

Escapes RegEx characters in provided String value.

Params:

NameTypeAttributeDescription
value String

String for escaping RegEx characters.

Return:

string

String with escaped RegEx characters.

public fileProcessor(formio: *, config: *) source

Params:

NameTypeAttributeDescription
formio *
config *

public findComponent(components: *, key: *, fn: *, path: *): * source

import {findComponent} from 'formiojs/src/utils/formUtils.js'

This function will find a component in a form and return the component AND THE PATH to the component in the form. Path to the component is stored as an array of nested components and their indexes.The Path is being filled recursively when you iterating through the nested structure. If the component is not found the callback won't be called and function won't return anything.

Params:

NameTypeAttributeDescription
components *
key *
fn *
path *

Return:

*

public findComponents(components: *, query: *): * source

import {findComponents} from 'formiojs/src/utils/formUtils.js'

Deprecated version of findComponents. Renamed to searchComponents.

Params:

NameTypeAttributeDescription
components *
query *

Return:

*

public flattenComponents(components: Object, includeAll: Boolean): Object source

import {flattenComponents} from 'formiojs/src/utils/formUtils.js'

Flatten the form components for data manipulation.

Params:

NameTypeAttributeDescription
components Object

The components to iterate.

includeAll Boolean

Whether or not to include layout components.

Return:

Object

The flattened components map.

public formatAsCurrency(value: any): String source

import {formatAsCurrency} from 'formiojs/src/utils/formUtils.js'

Formats provided value in way how Currency component uses it.

Params:

NameTypeAttributeDescription
value any

The value to format.

Return:

String

Value formatted for Currency component.

public generateFormChange(type: *, data: *): * source

import {generateFormChange} from 'formiojs/src/utils/formUtils.js'

Params:

NameTypeAttributeDescription
type *
data *

Return:

*

public getComponent(components: Object, key: String | Object): Object source

import {getComponent} from 'formiojs/src/utils/formUtils.js'

Get a component by its key

Params:

NameTypeAttributeDescription
components Object

The components to iterate.

key String | Object

The key of the component to get, or a query of the component to search.

Return:

Object

The component that matches the given key, or undefined if not found.

public getFormioUploadAdapterPlugin(fileService: *, component: *) source

import {getFormioUploadAdapterPlugin} from 'formiojs/src/providers/storage/uploadAdapter.js'

Params:

NameTypeAttributeDescription
fileService *
component *

public getStrings(form: *): * source

import {getStrings} from 'formiojs/src/utils/formUtils.js'

Iterate over all components in a form and get string values for translation.

Params:

NameTypeAttributeDescription
form *

Return:

*

public getValue(submission: Object, key: String): * source

import {getValue} from 'formiojs/src/utils/formUtils.js'

Get the value for a component key, in the given submission.

Params:

NameTypeAttributeDescription
submission Object

A submission object to search.

key String

A for components API key to search for.

Return:

*

public googledrive(formio: *): * source

Params:

NameTypeAttributeDescription
formio *

Return:

*

public hasCondition(component: *): boolean source

import {hasCondition} from 'formiojs/src/utils/formUtils.js'

Returns if this component has a conditional statement.

Params:

NameTypeAttributeDescription
component *

The component JSON schema.

Return:

boolean

TRUE - This component has a conditional, FALSE - No conditional provided.

public iconClass(iconset: *, name: *, spinning: *): * source

Params:

NameTypeAttributeDescription
iconset *
name *
spinning *

Return:

*

public indexeddb(): * source

Return:

*

public isLayoutComponent(component: Object): Boolean source

import {isLayoutComponent} from 'formiojs/src/utils/formUtils.js'

Determine if a component is a layout component or not.

Params:

NameTypeAttributeDescription
component Object

The component to check.

Return:

Boolean

Whether or not the component is a layout component.

public lessOrGreater(value: moment, format: [String], maxDate: Date, minDate: Date): {"message": *, "result": *} source

import {lessOrGreater} from 'formiojs/src/utils/calendarUtils.js'

Checks the value for a min date and max date.

Params:

NameTypeAttributeDescription
value moment

The value to check.

format [String]

A moment formats.

maxDate Date

The max date.

minDate Date

The min date.

  • @return {{message: string, result: boolean}}

Return:

{"message": *, "result": *}

public matchComponent(component: *, query: *): boolean source

import {matchComponent} from 'formiojs/src/utils/formUtils.js'

Matches if a component matches the query.

Params:

NameTypeAttributeDescription
component *
query *

Return:

boolean

public parseFloatExt(value: any): Number source

import {parseFloatExt} from 'formiojs/src/utils/formUtils.js'

Extension of standard #parseFloat(value) function, that also clears input string.

Params:

NameTypeAttributeDescription
value any

The value to parse.

Return:

Number

Parsed value.

public removeComponent(components: *, path: *) source

import {removeComponent} from 'formiojs/src/utils/formUtils.js'

Remove a component by path.

Params:

NameTypeAttributeDescription
components *
path *

public s3(formio: *): * source

Params:

NameTypeAttributeDescription
formio *

Return:

*

public searchComponents(components: *, query: *): * source

import {searchComponents} from 'formiojs/src/utils/formUtils.js'

Finds a component provided a query of properties of that component.

Params:

NameTypeAttributeDescription
components *
query *

Return:

*

public setXhrHeaders(formio: *, xhr: *) source

import {setXhrHeaders} from 'formiojs/src/providers/storage/xhr.js'

Params:

NameTypeAttributeDescription
formio *
xhr *

public url(formio: *): * source

Params:

NameTypeAttributeDescription
formio *

Return:

*