Basic Components
Learn more about the Basic components
Basic components are found at the top of the component groupings within the Form Builder. These components are more commonly used on traditional web forms and should be familiar components if you have ever used a Form Builder in the past. You can find information for each of the Basic Components like unique settings, JSON code, and field examples.
A Text Field can be used for short and general text input. There are options to define input masks and validations, allowing users to mold information into desired formats.
Unique Settings
Field Examples
Guidance
JSON
Widget:
The widget is the display UI used to input the value of the field. By default, the widget will be set to a traditional Input Field, however, you can change the widget to turn the text field into a calendar picker.
Input Mask: Use an Input Mask when a predefined input format is required. This is helpful for forcing input formats such as phone numbers, postal codes, SSN, etc.
9: numeric
a: alphabetical
*: alphanumeric
Example a Phone Number mask: (999) 999-9999
See the jquery.inputmask documentation for more information.
When should I use the Text Field component?
- Unpredictable or freeform responses. If you can’t reasonably predict a user’s answer to a prompt and there might be wide variability in users’ answers.
- Input simplicity. When using another type of input will make answering more difficult. For example, birthdays and other known dates are easier to type in than they are to select from a date picker.
- Pasted content. When users want to be able to paste in a response.
{
"label": "Text Field",
"disableSortingAndFiltering": false,
"tableView": true,
"key": "textField",
"type": "textfield",
"input": true
}
A Text Area is a multi-line input field that allows for longer text. The Text Area can also be converted to WYSIWYG content editor.
Unique Settings
Field Examples
Guidance
JSON
Rows: Controls how many default rows are set in the Text Area
Auto Expand: The Text Area will automatically expand vertically as the user types into the field.
Editor: This option will convert the text area into one of the following WYSIWYG Editors
Enable Image Upload: Allows the user to upload an image to the WYSIWG Editor
Editor Settings: Here you can modify the code base of the WYSIWYG Editor to customize the UI specific to your needs.
-Use the Text Area when larger text input is required
-Switch the Text Area to a WYSWIG to give the user the ability to format and customize the text input.
{
"label": "Text Area",
"autoExpand": false,
"tableView": true,
"key": "textArea",
"type": "textarea",
"input": true
}
Property | Description | Value | Required | Default |
|---|---|---|---|---|
rows | How many rows this text area should contain. | Any integer | true | 3 |
wysiwyg | Determines if this text area should attach a wysiwyg editor. | true for default wysiwyg configuration, or a JSON object of the wysiwyg settings. | false | false |
Use a Number field whenever a field should be limited to a number value type. There are options to set thousands separators, decimal places, and decimal requirements.
Unique Settings
Field Examples
Guidance
JSON
Use Thousands Separator: Check this setting if you would like the value in this component to separate thousands by a local delimiter.
Decimal Places: The maximum number of decimal places for the values in this field.
Require Decimals: Always show decimals for this field, even if trailing zeros.
Decimal Symbol: Change the default Decimal Symbol for the Number component.
- Use the Number component when dealing with input types that will be specific to numeric input
- Use the decimal places settings for numeric requirements like a percentage that may need specific decimal places included in the submission
{
"label": "Number",
"mask": false,
"tableView": false,
"delimiter": false,
"requireDecimal": false,
"inputFormat": "plain",
"truncateMultipleSpaces": false,
"key": "number1",
"type": "number",
"input": true
}
Property | Description | Value | Required | Default |
|---|---|---|---|---|
validate.min | The minimum value this number could be | Any number | false | |
validate.max | The maximum value this number could be | Any number | false | |
validate.step | The granularity of this number input | Any number | false | any |
validate.integer | If this number should be an integer | boolean | false | |
The password field has the same options as a text field component. It differs from a text field in that its HTML
<input> type will be password instead of text. This will cause the field to display hidden input symbols instead of the entered value.Unique Settings
Field Examples
JSON
There are no unique settings for the Password component.
{
"label": "Password",
"tableView": false,
"key": "password1",
"type": "password",
"input": true,
"protected": true
}
A check box can be used for boolean value input field. It can either be checked (true) or unchecked (false). There are options to set Shortcut and Input Type.
Unique Settings
Field Examples
Guidance
JSON
Shortcut: Add a keyboard shortcut to check/uncheck the component.
Input Type: The input type can be changed from a single input value checkbox or a multi-valued radio component.
{
"label": "Checkbox",
"tableView": false,
"key": "checkbox",
"type": "checkbox",
"input": true
}
This multi-valued component allows users to select one or more options in checkbox style format. Set your values within the Data tab of the settings. Apply unique settings such as value shortcuts and min/max value validation.
Unique Settings
Field Examples
Guidance
JSON
Data Source Type: The source to use for the Select Box options:
Values: Create your own list of static values for the Select Box options. The Label is the front-end identifier for the end user. The value is the back-end identifier for the option and is what is saved to the Database.
When setting the option value, use only Strings or Numeric values.
Data Source URL: Designate a URL that will provide the option values for the Select Dropdown. Use the Item Template to determine what part of the URL's object will be used as the option values.
For example, suppose you wish to populate your Select Box with a list of all U.S. States of You can use an external JSON URL like the following.
https://cdn.rawgit.com/mshafrir/2646763/raw/states_titlecase.json
Place the URL within the Data Source URL. Provide a Value Property to represent the option which is what will save within the meta-data. When the value is left blank, the entire object will be saved for the option. Modify the Item Template to determine what part of the object the end user will see when choosing an option.
In the image below, the abbreviation, set by the Value Property, will be saved in the meta-data to represent the option within the back end. The end user will see the State name, set by the Item Template, for the option on the front end.
Shortcut: Add a keyboard shortcut for the designated option.
Options Label Position: Determines the position of the option label relative to it's checkbox
Inline Layout: Displays the option values horizontally
Min/Max Checked Number: Validation that determines the minimum and maximum amount of options to check. Checked options below the minimum will trigger front-end validation. When the maximum amount of options is checked, the remaining options will become disabled.
Min/Max Checked Error Message: Determines the validation message displayed to the user for the minimum or maximum option amount.
- Use the hamburger icon to rearrange your options.
{
"label": "Select Boxes",
"optionsLabelPosition": "right",
"tableView": false,
"defaultValue": {
"a": false,
"b": false,
"c": false
},
"values": [
{
"label": "A",
"value": "a",
"shortcut": ""
},
{
"label": "B",
"value": "b",
"shortcut": ""
},
{
"label": "C",
"value": "c",
"shortcut": ""
}
],
"key": "selectBoxes",
"type": "selectboxes",
"input": true,
"inputType": "checkbox"
Property | Description | Value | Required | Default |
|---|---|---|---|---|
hideLabel | Whether to hide the checkbox label or not when showing it in the form. | true or false | false | true |
datagridLabel | The label to show as the column name when this element is placed within a data grid element. | Any string | false | |
name | The HTML name to provide to this checkbox input | Any valid HTML name value | false | |
value | The HTML value to provide to this checkbox input | Any valid HTML value | false | |
The Select component displays a list of values in a dropdown list where users can select one of the values. This component has flexibility on where the data source originates from. There is also a large offering of settings providing different ways of filtering, querying, and loading data values.
Unique Settings
Data Source Types
Field Examples
Guidance
JSON
Widget Type: Change the Select dropdown widget type:
Unique Options: Display only unique dropdown options removing repeated values.
Multiple Values: Allows the user to select more than one option. Options are saved like tags on the field when the setting is enabled.
Data Source Type: The source to use for the Select component options:
Value, URL, Resource, Raw JSON, and Custom.
(More information in the next tab Data Souce Types)
Storage Type: Select how you want the field data to be stored. Defaults to 'Autotype' if an option is not selected:
String, Number, Boolean, Object
ID Path: Designate the path to select the option ID
Item Template: HTML template that determines how the Select options are displayed within the dropdown. You can use the item variable to access the current object in the array.
EG embed the value by using
{{ item.value }} in a template.Lazy Load Data: When set, a request will not be fired to the URL until this control is within focus. This can improve performance if you have many Select dropdowns on your form where the APIs will only fire when the field is activated.
Request Headers: Set any headers that should be sent along with the request to the url, useful for authentication.
Data Path: The property within the source data, where iterable items reside.
For example: results.items or results[0].items
Value Property: The property of each item in the data source to use as the select value. If not specified, the item itself will be used.
Disable Limiting Response: When enabled, the request will not include the limit and skip options within the query string. This can help with unnecessary requests and performance.
Search Query Name: The name of the search query string parameter used when sending a request to filter results with. The server at the URL must handle this query parameter. If URL or Resource is selected as Data Source Type, enter the name of the search query parameter to filter requests with.
Example, if your URL is
http://api.dogs.com/dogs, and Search Query Name is set to type, and then the user types nice in the Select field, then this component will send a request to http://api.dogs.com/dogs?type=nice and update the Select items with the results. If this option is omitted, no new requests will be made when a user enters text in the select field.Search Delay Request: The delay in seconds before the search request is sent, measured from the last character input in the search field.
Default is set to 0.3
Filter Query: Provide additional filtering within the dropdown using query parameters.
Sort Query: Provide additional sorting within the dropdown using query parameters
Limit: Use this to limit the number of items to request or view.
Formio Authenticate: Check this if you would like to use Formio Authentication with the request.
Disables Storing Request Result in the Cache: Check it if you don't want the requests and their results to be stored in the cache. By default, it is stored and if the Select tries to make the request to the same URL with the same parameters, the cached data will be returned. It allows to increase performance, but if the remote source's data is changing quite often and you always need to keep it up-to-date, uncheck this option.
Refresh Options On: Refresh the field options based on a change from another field on the form, or any change on the form. This is helpful when dealing with dynamic values, such as the Cascading Select Dropdowns
Refresh Options On Blur: Refresh the field options when a specific field or any field on the form is blurred.
Clear Value Option On Refresh: Clears any selected value if the field is reset by the Refresh Options On setting.
Enable Static Search: When checked, the select dropdown will allow for searching within the static list of items provided.
Search Threshold: Determines when the select component match algorithm gives up. A threshold of 0.0 requires a perfect match, a threshold of 1.0 would match anything. This setting is set to 0.3 by default.
Read Only Value: Check this if you would like to only display the value when in Read Only mode.
Choices.js options: A raw JSON object to use as options for the Select component. Refer to the Choices.js documentation for more information.
Use Exact Search: Disables the Search Algorithm and only allows exact searches to return an option.
Create your own list of static values for the select dropdown. The default source type for the Select component. The Label is the front-end identifier for the end user. The value is the back-end identifier for the option and is what is saved to the Database.
When setting the option value, use only Strings or Numeric values.
Designate a URL that will provide the option values for the Select Dropdown. Use the Item Template to determine what part of the URL's object will be used as the option values.
For example, suppose you wish to populate your Select dropdown with a list of all States of the U.S. You can use an external JSON URL like the following.
https://cdn.rawgit.com/mshafrir/2646763/raw/states_titlecase.json
Place the URL within the Data Source URL. Provide a Value Property to represent the option which is what will save within the meta-data. When the value is left blank, the entire object will be saved for the option. Modify the Item Template to determine what part of the object the end user will see when choosing an option.
In the image below, the abbreviation, which is set by the Value Property, will be saved in the meta-data to represent the option within the back end. The end user will see the State name, set by the Item Template, for the option on the front end.
Data Source URL: The URL that will return the JSON array
Source of data is mapped to a Resource within your project to populate the entire Resource Object or underlying field data within the selected Resource as the Select component options.
Resource: Select which Resource within your project the Select component will map to.
Value Property: Select which field within the chosen Resouce the Select component will pull data from. Leave this empty to reference the entire Resource object.
*When a value property is selected, the Item Template will automatically be set based on your selection.
Select Fields: The properties on the resource to return as part of the options. Separate property names by commas. If left blank, all properties will be returned.
Add Resource: Dynamically adds a new record to the connected Resource
Provide raw JSON data as the select field value.
Data Source Raw JSON: This is where you will save your JSON data
[{"name": "John", "email": "[email protected]"}, {"name": "Jane", "email": "[email protected]"}].
Write custom code to provide value options for the Select component.
Custom Values: Write custom code to return the value options or a promise with value options. The form data object is available.
values = data['myKey'];
Organize your values
Use the hamburger icon to rearrange your option values within the Select settings.
Dynamic Select Filtering
A very common use case that many people have in forms is to dynamically filter a Select dropdown based on the selection of another Select dropdown. The most typical use case is a form that provides the Make, Model and Year of vehicles where when you select the Make dropdown, it filters the Model dropdown for those that are inside that Make. This functionality is covered in detail in our user guide resources section.
{
"label": "Select",
"widget": "choicesjs",
"tableView": true,
"data": {
"values": [
{
"label": "A",
"value": "a"
},
{
"label": "B",
"value": "b"
},
{
"label": "C",
"value": "c"
}
]
},
"key": "select1",
"type": "select",
"input": true
}// Some code
The radio component is a field that allows users to select a single option from a list of options displayed in radio-style format. Users can click a selected option to deselect it, returning the field back to its original state. allows
Unique Settings
Field Examples
Guidance
JSON
Data Source Type: The source to use for the Select Box options:
Values: Create your own list of static values for the Select Box options. The Label is the front-end identifier for the end user. The value is the back-end identifier for the option and is what is saved to the Database.
When setting the option value, use only Strings or Numeric values.
Data Source URL: Designate a URL that will provide the option values for the Select Dropdown. Use the Item Template to determine what part of the URL's object will be used as the option values.
For example, suppose you wish to populate your Select Box with a list of all U.S. States of You can use an external JSON URL like the following.
https://cdn.rawgit.com/mshafrir/2646763/raw/states_titlecase.json
Place the URL within the Data Source URL. Provide a Value Property to represent the option which is what will save within the meta-data. When the value is left blank, the entire object will be saved for the option. Modify the Item Template to determine what part of the object the end user will see when choosing an option.
In the image below, the abbreviation, set by the Value Property, will be saved in the meta-data to represent the option within the back end. The end user will see the State name, set by the Item Template, for the option on the front end.
Shortcut: Add a keyboard shortcut for the designated option.
Options Label Position: Determines the position of the option label relative to the option bubble
Inline Layout: Displays the option values horizontally
- Use the hamburger icon to rearrange your option values.
{
"label": "Radio",
"optionsLabelPosition": "right",
"customClass": "pl-3",
"inline": false,
"tableView": false,
"values": [
{
"label": "A",
"value": "a",
"shortcut": ""
},
{
"label": "B",
"value": "b",
"shortcut": ""
},
{
"label": "C",
"value": "c",
"shortcut": ""
}
],
"key": "radio",
"type": "radio",
"input": true
}
Property | Description | Value | Required | Default |
|---|---|---|---|---|
values | An array of value objects | Array of value objects, where each item in the array has the following properties.
| true | [] |
Buttons can be added to perform various actions within the form. The most obvious function of the Button component is the Submission action. However, you can also utilize the Button component to trigger events associated with workflow logic, reset field data, authenticate to an OAuth provider, and more.
In addition to functionality, the button component offers many settings to change the style and theme of the component.
Unique Settings
Field Examples
Guidance
JSON
Action: The functionality that executes when the button is clicked. Click the event to show additional settings related to the selected action:
Submit - Submits the form to the back-end server
Save In State - This button action works alongside the Save In State workflow and facilitates a 'Save as Draft' workflow.
Inheritently the action will bypass validation giving the submission a different state.
Reset - Reset all fields on the form back to their pristine state
Event - Triggers an 'event' on the form which is usually correlated to application logic or form workflow logic
Oauth - Opens an OAuth authentication popup. This will only work after it has been assigned to an OAuth Action.
Post to URL -
Custom - Write custom code to fire
Save On Enter: Use the Enter key to submit the form
Size: Determines the position of the option label relative to the option bubble
Block Button: Spans the button horizontally across the form
Left/Right Icon: Set an icon to the left or right side of the button label using Font Awesome icon classes.
Disable on Form Invalid: If any field on the form is invalid, disable the button.
- Use the button component to Reset the fields on a form, clearing any data
- Fire off events using the button to initiate complex workflows in conjunction with other components like the Data Source
{
"label": "Submit",
"block": true,
"leftIcon": "fa fa-send",
"disableOnInvalid": true,
"tableView": false,
"key": "submit",
"type": "button",
"input": true,
"saveOnEnter": false
}
Last modified 1mo ago