Users Guide
Developer Guide
Deployments
JavaScript Utilities
This section documents the utilities functions available within the JavaScript SDK
Introduction
The Form.io Utilities class is a part of the JavaScript SDK, but provides a number of methods that makes working with Form.io forms within your applications easier.
Installation
To install the Utilities, you can either import them directly into your application as follows.
1
import Utils from 'formiojs/utils';
Copied!
or they can be used as part of the Form.io renderer by including the following script in your application.
1
<script src="https://cdn.form.io/formiojs/formio.form.min.js"></script>
Copied!
and then you can find the Utilities methods as part of the
Utils property on the Formio object.1
Formio.Utils.eachComponent(....)
Copied!
Utility Functions
The following are common functions that can be used within the Form.io Utilities library.
eachComponent(components, fn, [includeAll])
eachComponent(components, fn, [includeAll])Calls
fn(component) for each component in components, accounting for nested layout components. (Does not call for layout components themselves, unless includeAll is true).Parameter
Description
components
An array of JSON form components to iterate over.
fn
The function to call for each input component.
includeAll
Boolean to indicate if we should include all components including layout components.
The current data path of the element. Example: data.user.firstName
1
var utils = require('formiojs/utils');
2
utils.eachComponent(form.components, function(component) {
3
// Do something...
4
})
Copied!
getComponent(components, key)
getComponent(components, key)Returns the component with the given
key or undefined if not found.Parameter
Description
components
An array of JSON form components to iterate over.
key
The key of the component you would like to retrieve.
1
var utils = require('formiojs/utils');
2
var component = utils.getComponent(form.components, 'myKey');
Copied!
findComponents(components, query)
findComponents(components, query)Returns an array of components that match the find query criteria. This query is very similar to MongoDB where if you wish to find a nested query, you would provide the key as the path of the property using dot notation.
Parameter
Description
components
An array of JSON form components to iterate over.
query
A JSON object to use as a query to find a certain component within a form.
Here is an example.
1
// Find all textfields with a specific custom property.
2
var utils = require('formiojs/utils');
3
var comps = utils.findComponents(form.components, {
4
'type': 'textfield',
5
'properties.objectId': '2345'
6
});
7
​
8
// Should return all textfield components with 'properties.objectId' = '2345'.
9
console.log(comps);
Copied!
searchComponents(components, query)
searchComponents(components, query)Finds a component provided a query of properties of that component.
Parameter
Description
components
An array of JSON form components to iterate over.
query
The query to pass to
matchComponent.matchComponent(component, query)
matchComponent(component, query)Matches if a component matches the query.
Parameter
Description
component
A component JSON you would like to match against a query.
query
A JSON query to use as the match query.
1
const component = {
2
type: 'textfield',
3
key: 'firstName',
4
label: 'First Name'
5
};
6
if (utils.matchComponent(component, {
7
key: 'firstName
8
}) {
9
console.log('The component matches!!');
10
}
Copied!
​
flattenComponents(components, includeAll)
flattenComponents(components, includeAll)Returns a key-value object where the keys are the keys for each component in
components and each key points to the corresponding component. This includes nested components as well. Pass true for includeAll if you want to include layout components.Parameter
Description
components
An array of JSON form components to iterate over.
includeAll
Boolean to indicate if you wish to include all components including layout components.
1
var utils = require('formiojs/utils');
2
var flattened = utils.flattenComponents(form.components);
3
console.log(flattened['myNestedComponent']);
Copied!
isLayoutComponent(component)
isLayoutComponent(component)Determine if a component is a layout component.
Parameter
Description
component
The component JSON to determine if this is a layout component
1
var utils = require('formiojs/utils');
2
var layoutComponent = utils.isLayoutComponent(form.components[0]);
3
console.log(layoutComponent);
Copied!
getValue(submission, key)
getValue(submission, key)Get the value for a components API key, from the given submission. Recursively searches the submission for the key.
Parameter
Description
submission
The submission JSON object
key
The component key you would like to fetch the value from within the submission.
1
var utils = require('formiojs/utils');
2
var value = utils.getValue(submission, 'myComponent'); // The value or undefined.
Copied!
parseFloat(value)
parseFloat(value)Extension of standard parseFloat function, that also clears input string. Useful for Currency component.
Parameter
Description
value
The value you would like to parse.
1
utils.parseFloat('12,345,678.90'); // -> 12345678.90
Copied!
formatAsCurrency(value)
formatAsCurrency(value)Parameter
Description
value
The value you would like to format.
1
utils.formatAsCurrency(123.4); // -> '123.40'
2
utils.formatAsCurrency(12345678.9); // -> '12,345,678.90'
3
utils.formatAsCurrency(12345678.915); // -> '12,345,678.92'
4
utils.formatAsCurrency('12345678.915'); // -> '12,345,678.92'
Copied!
escapeRegExCharacters(value)
escapeRegExCharacters(value)Escapes RegEx characters in provided String value.
Parameter
Description
value
The value you would like to escape the regex characters from.
1
utils.escapeRegExCharacters('[form.io](https://form.io/)'); // -> '\[form\.io\]\(https:\/\/form\.io\)'
Copied!
boolValue(value)
boolValue(value)Determines the boolean value of a setting.
isMongoId(text)
isMongoId(text)Check to see if an ID is a mongoID.
checkCondition(component, row, data, form, instance)
checkCondition(component, row, data, form, instance)Checks the conditions for a provided component and data.
Parameter
Description
component
The component JSON
row
Contextual row data
data
Full submission data
form
The form JSON schema
instance
The component instance this method is being executed with.
unescapeHTML(str)
unescapeHTML(str)Unescape HTML characters like <, >, & and etc.
convertStringToHTMLElement(str, selector)
convertStringToHTMLElement(str, selector)Make HTML element from string
guid()
guid()Generate a GUID
isValidDate(date)
isValidDate(date)Checks a date to see if it is valid.
formatDate(value, format, timezone, flatPickrInputFormat)
formatDate(value, format, timezone, flatPickrInputFormat)Format a date provided a value, format, and timezone object.
getBrowserInfo()
getBrowserInfo()Get browser name and version
isInputComponent(componentJson)
isInputComponent(componentJson)Checks to see if a component JSON is an input component.
Last modified 10mo ago
Copy link
Contents
Introduction
Installation
Utility Functions
eachComponent(components, fn, [includeAll])
getComponent(components, key)
findComponents(components, query)
searchComponents(components, query)
matchComponent(component, query)
flattenComponents(components, includeAll)
isLayoutComponent(component)
getValue(submission, key)
parseFloat(value)
formatAsCurrency(value)
escapeRegExCharacters(value)
boolValue(value)
isMongoId(text)
checkCondition(component, row, data, form, instance)
unescapeHTML(str)
convertStringToHTMLElement(str, selector)
guid()
isValidDate(date)
formatDate(value, format, timezone, flatPickrInputFormat)
getBrowserInfo()
isInputComponent(componentJson)