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 |
Email(extend: ...*): * |
|
public |
Fieldset(extend: ...*): * |
|
public |
File(extend: ...*): * |
|
public |
Form(extend: ...*): * |
|
public |
HTML(extend: ...*): * |
|
public |
Hidden(extend: ...*): * |
|
public |
ListComponent(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 |
Iterate through each component within a form. |
|
public |
escapeRegExCharacters(value: String): string 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 |
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 |
indexeddb(): * |
|
public |
isLayoutComponent(component: Object): Boolean 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 |
registerModule(plugin: *) Register a module |
|
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: *): * |
|
public |
|
Static Public
public Address(extend: ...*): * source
import Address from '@formio/js/src/components/address/Address.form.js'
Params:
Name | Type | Attribute | Description |
extend | ...* |
Return:
* |
public Button(extend: ...*): * source
import Button from '@formio/js/src/components/button/Button.form.js'
Params:
Name | Type | Attribute | Description |
extend | ...* |
Return:
* |
public Checkbox(extend: ...*): * source
import Checkbox from '@formio/js/src/components/checkbox/Checkbox.form.js'
Params:
Name | Type | Attribute | Description |
extend | ...* |
Return:
* |
public Columns(extend: ...*): * source
import Columns from '@formio/js/src/components/columns/Columns.form.js'
Params:
Name | Type | Attribute | Description |
extend | ...* |
Return:
* |
public Component(extend: ...*): {"components": *} source
import Component from '@formio/js/src/components/_classes/component/Component.form.js'
Params:
Name | Type | Attribute | Description |
extend | ...* |
Return:
{"components": *} |
public Container(extend: ...*): * source
import Container from '@formio/js/src/components/container/Container.form.js'
Params:
Name | Type | Attribute | Description |
extend | ...* |
Return:
* |
public Content(extend: ...*): * source
import Content from '@formio/js/src/components/content/Content.form.js'
Params:
Name | Type | Attribute | Description |
extend | ...* |
Return:
* |
public Currency(extend: ...*): * source
import Currency from '@formio/js/src/components/currency/Currency.form.js'
Params:
Name | Type | Attribute | Description |
extend | ...* |
Return:
* |
public DataGrid(extend: ...*): * source
import DataGrid from '@formio/js/src/components/datagrid/DataGrid.form.js'
Params:
Name | Type | Attribute | Description |
extend | ...* |
Return:
* |
public DataMap(extend: ...*): * source
import DataMap from '@formio/js/src/components/datamap/DataMap.form.js'
Params:
Name | Type | Attribute | Description |
extend | ...* |
Return:
* |
public DateTime(extend: ...*): * source
import DateTime from '@formio/js/src/components/datetime/DateTime.form.js'
Params:
Name | Type | Attribute | Description |
extend | ...* |
Return:
* |
public Day(extend: ...*): * source
import Day from '@formio/js/src/components/day/Day.form.js'
Params:
Name | Type | Attribute | Description |
extend | ...* |
Return:
* |
public EditGrid(extend: ...*): * source
import EditGrid from '@formio/js/src/components/editgrid/EditGrid.form.js'
Params:
Name | Type | Attribute | Description |
extend | ...* |
Return:
* |
public Email(extend: ...*): * source
import Email from '@formio/js/src/components/email/Email.form.js'
Params:
Name | Type | Attribute | Description |
extend | ...* |
Return:
* |
public Fieldset(extend: ...*): * source
import Fieldset from '@formio/js/src/components/fieldset/Fieldset.form.js'
Params:
Name | Type | Attribute | Description |
extend | ...* |
Return:
* |
public File(extend: ...*): * source
import File from '@formio/js/src/components/file/File.form.js'
Params:
Name | Type | Attribute | Description |
extend | ...* |
Return:
* |
public Form(extend: ...*): * source
import Form from '@formio/js/src/components/form/Form.form.js'
Params:
Name | Type | Attribute | Description |
extend | ...* |
Return:
* |
public HTML(extend: ...*): * source
import HTML from '@formio/js/src/components/html/HTML.form.js'
Params:
Name | Type | Attribute | Description |
extend | ...* |
Return:
* |
public Hidden(extend: ...*): * source
import Hidden from '@formio/js/src/components/hidden/Hidden.form.js'
Params:
Name | Type | Attribute | Description |
extend | ...* |
Return:
* |
public ListComponent(extend: ...*): * source
import ListComponent from '@formio/js/src/components/_classes/list/ListComponent.form.js'
Params:
Name | Type | Attribute | Description |
extend | ...* |
Return:
* |
public NestedComponent(extend: ...*): * source
import NestedComponent from '@formio/js/src/components/_classes/nested/NestedComponent.form.js'
Params:
Name | Type | Attribute | Description |
extend | ...* |
Return:
* |
public Number(extend: ...*): * source
import Number from '@formio/js/src/components/number/Number.form.js'
Params:
Name | Type | Attribute | Description |
extend | ...* |
Return:
* |
public Panel(extend: ...*): * source
import Panel from '@formio/js/src/components/panel/Panel.form.js'
Params:
Name | Type | Attribute | Description |
extend | ...* |
Return:
* |
public Password(extend: ...*): * source
import Password from '@formio/js/src/components/password/Password.form.js'
Params:
Name | Type | Attribute | Description |
extend | ...* |
Return:
* |
public PhoneNumber(extend: ...*): * source
import PhoneNumber from '@formio/js/src/components/phonenumber/PhoneNumber.form.js'
Params:
Name | Type | Attribute | Description |
extend | ...* |
Return:
* |
public Radio(extend: ...*): * source
import Radio from '@formio/js/src/components/radio/Radio.form.js'
Params:
Name | Type | Attribute | Description |
extend | ...* |
Return:
* |
public ReCaptcha(): * source
import ReCaptcha from '@formio/js/src/components/recaptcha/ReCaptcha.form.js'
Return:
* |
public Resource(extend: ...*): * source
import Resource from '@formio/js/src/components/resource/Resource.form.js'
Params:
Name | Type | Attribute | Description |
extend | ...* |
Return:
* |
public Select(extend: ...*): * source
import Select from '@formio/js/src/components/select/Select.form.js'
Params:
Name | Type | Attribute | Description |
extend | ...* |
Return:
* |
public SelectBoxes(extend: ...*): * source
import SelectBoxes from '@formio/js/src/components/selectboxes/SelectBoxes.form.js'
Params:
Name | Type | Attribute | Description |
extend | ...* |
Return:
* |
public Signature(extend: ...*): * source
import Signature from '@formio/js/src/components/signature/Signature.form.js'
Params:
Name | Type | Attribute | Description |
extend | ...* |
Return:
* |
public Survey(extend: ...*): * source
import Survey from '@formio/js/src/components/survey/Survey.form.js'
Params:
Name | Type | Attribute | Description |
extend | ...* |
Return:
* |
public Table(extend: ...*): * source
import Table from '@formio/js/src/components/table/Table.form.js'
Params:
Name | Type | Attribute | Description |
extend | ...* |
Return:
* |
public Tabs(extend: ...*): * source
import Tabs from '@formio/js/src/components/tabs/Tabs.form.js'
Params:
Name | Type | Attribute | Description |
extend | ...* |
Return:
* |
public Tags(extend: ...*): * source
import Tags from '@formio/js/src/components/tags/Tags.form.js'
Params:
Name | Type | Attribute | Description |
extend | ...* |
Return:
* |
public TextArea(extend: ...*): * source
import TextArea from '@formio/js/src/components/textarea/TextArea.form.js'
Params:
Name | Type | Attribute | Description |
extend | ...* |
Return:
* |
public TextField(extend: ...*): * source
import TextField from '@formio/js/src/components/textfield/TextField.form.js'
Params:
Name | Type | Attribute | Description |
extend | ...* |
Return:
* |
public Time(extend: ...*): * source
import Time from '@formio/js/src/components/time/Time.form.js'
Params:
Name | Type | Attribute | Description |
extend | ...* |
Return:
* |
public Tree(extend: ...*): * source
import Tree from '@formio/js/src/components/tree/Tree.form.js'
Params:
Name | Type | Attribute | Description |
extend | ...* |
Return:
* |
public Unknown(): {"components": *} source
import Unknown from '@formio/js/src/components/unknown/Unknown.form.js'
Return:
{"components": *} |
public Url(extend: ...*): * source
import Url from '@formio/js/src/components/url/Url.form.js'
Params:
Name | Type | Attribute | Description |
extend | ...* |
Return:
* |
public Well(extend: ...*): * source
import Well from '@formio/js/src/components/well/Well.form.js'
Params:
Name | Type | Attribute | Description |
extend | ...* |
Return:
* |
public applyFormChanges(form: *, changes: *): {"form": *, "failed": *} source
import {applyFormChanges} from '@formio/js/src/utils/formUtils.js'
Params:
Name | Type | Attribute | Description |
form | * | ||
changes | * |
Return:
{"form": *, "failed": *} |
public azure(formio: *): * source
import azure from '@formio/js/src/providers/storage/azure.js'
Params:
Name | Type | Attribute | Description |
formio | * |
Return:
* |
public checkInvalidDate(value: String, format: [String], maxDate: Date, minDate: Date): * source
import {checkInvalidDate} from '@formio/js/src/utils/calendarUtils.js'
Checks the entered date for validity.
Return:
* |
public dropbox(formio: *): * source
import dropbox from '@formio/js/src/providers/storage/dropbox.js'
Params:
Name | Type | Attribute | Description |
formio | * |
Return:
* |
public eachComponent(components: Object, fn: Function, includeAll: Boolean, path: String, parent: Object) source
import {eachComponent} from '@formio/js/src/utils/formUtils.js'
Iterate through each component within a form.
Params:
Name | Type | Attribute | Description |
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 escapeRegExCharacters(value: String): string source
import {escapeRegExCharacters} from '@formio/js/src/utils/formUtils.js'
Escapes RegEx characters in provided String value.
Params:
Name | Type | Attribute | Description |
value | String | String for escaping RegEx characters. |
public fileProcessor(formio: *, config: *) source
import fileProcessor from '@formio/js/src/providers/processor/fileProcessor.js'
Params:
Name | Type | Attribute | Description |
formio | * | ||
config | * |
public findComponent(components: *, key: *, fn: *, path: *): * source
import {findComponent} from '@formio/js/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:
Name | Type | Attribute | Description |
components | * | ||
key | * | ||
fn | * | ||
path | * |
Return:
* |
public findComponents(components: *, query: *): * source
import {findComponents} from '@formio/js/src/utils/formUtils.js'
Deprecated version of findComponents. Renamed to searchComponents.
Params:
Name | Type | Attribute | Description |
components | * | ||
query | * |
Return:
* |
public flattenComponents(components: Object, includeAll: Boolean): Object source
import {flattenComponents} from '@formio/js/src/utils/formUtils.js'
Flatten the form components for data manipulation.
public formatAsCurrency(value: any): String source
import {formatAsCurrency} from '@formio/js/src/utils/formUtils.js'
Formats provided value in way how Currency component uses it.
Params:
Name | Type | Attribute | Description |
value | any | The value to format. |
public generateFormChange(type: *, data: *): * source
import {generateFormChange} from '@formio/js/src/utils/formUtils.js'
Params:
Name | Type | Attribute | Description |
type | * | ||
data | * |
Return:
* |
public getComponent(components: Object, key: String | Object): Object source
import {getComponent} from '@formio/js/src/utils/formUtils.js'
Get a component by its key
public getFormioUploadAdapterPlugin(fileService: *, component: *) source
import {getFormioUploadAdapterPlugin} from '@formio/js/src/providers/storage/uploadAdapter.js'
Params:
Name | Type | Attribute | Description |
fileService | * | ||
component | * |
public getStrings(form: *): * source
import {getStrings} from '@formio/js/src/utils/formUtils.js'
Iterate over all components in a form and get string values for translation.
Params:
Name | Type | Attribute | Description |
form | * |
Return:
* |
public getValue(submission: Object, key: String): * source
import {getValue} from '@formio/js/src/utils/formUtils.js'
Get the value for a component key, in the given submission.
Return:
* |
public googledrive(formio: *): * source
import googledrive from '@formio/js/src/providers/storage/googleDrive.js'
Params:
Name | Type | Attribute | Description |
formio | * |
Return:
* |
public hasCondition(component: *): boolean source
import {hasCondition} from '@formio/js/src/utils/formUtils.js'
Returns if this component has a conditional statement.
Params:
Name | Type | Attribute | Description |
component | * | The component JSON schema. |
public indexeddb(): * source
import indexeddb from '@formio/js/src/providers/storage/indexeddb.js'
Return:
* |
public isLayoutComponent(component: Object): Boolean source
import {isLayoutComponent} from '@formio/js/src/utils/formUtils.js'
Determine if a component is a layout component or not.
Params:
Name | Type | Attribute | Description |
component | Object | The component to check. |
public lessOrGreater(value: moment, format: [String], maxDate: Date, minDate: Date): {"message": *, "result": *} source
import {lessOrGreater} from '@formio/js/src/utils/calendarUtils.js'
Checks the value for a min date and max date.
Return:
{"message": *, "result": *} |
public matchComponent(component: *, query: *): boolean source
import {matchComponent} from '@formio/js/src/utils/formUtils.js'
Matches if a component matches the query.
Params:
Name | Type | Attribute | Description |
component | * | ||
query | * |
public parseFloatExt(value: any): Number source
import {parseFloatExt} from '@formio/js/src/utils/formUtils.js'
Extension of standard #parseFloat(value) function, that also clears input string.
Params:
Name | Type | Attribute | Description |
value | any | The value to parse. |
public registerModule(plugin: *) source
import {registerModule} from '@formio/js/src/formio.form.js'
Register a module
Params:
Name | Type | Attribute | Description |
plugin | * |
public removeComponent(components: *, path: *) source
import {removeComponent} from '@formio/js/src/utils/formUtils.js'
Remove a component by path.
Params:
Name | Type | Attribute | Description |
components | * | ||
path | * |
public s3(formio: *): * source
import s3 from '@formio/js/src/providers/storage/s3.js'
Params:
Name | Type | Attribute | Description |
formio | * |
Return:
* |
public searchComponents(components: *, query: *): * source
import {searchComponents} from '@formio/js/src/utils/formUtils.js'
Finds a component provided a query of properties of that component.
Params:
Name | Type | Attribute | Description |
components | * | ||
query | * |
Return:
* |
public setXhrHeaders(formio: *, xhr: *) source
import {setXhrHeaders} from '@formio/js/src/providers/storage/xhr.js'
Params:
Name | Type | Attribute | Description |
formio | * | ||
xhr | * |
public url(formio: *): * source
import url from '@formio/js/src/providers/storage/url.js'
Params:
Name | Type | Attribute | Description |
formio | * |
Return:
* |
public useModule(defaultFn: undefined): * source
import {useModule} from '@formio/js/src/formio.form.js'
Params:
Name | Type | Attribute | Description |
defaultFn | undefined |
|
Return:
* |