Components JSON Schema

Every component that can be rendered within a form also adheres to a JSON schema definition used to describe how that component behaves within the form. Every component that is rendered within a form shares a common schema that is used to represent the component as it is rendered within the form. Here are the common parameters that all components share.

Common Parameters

Property	Description	Value	Required	Default
type	The type of component	address	yes	address
key	The API key for this field.	any string	yes
label	The HTML label to give this component	any string	no
placeholder	The text to show in the input before they type.	any string	no
input	Determines if this is an input from the user.	true or false	yes	true
tableView	Determines if this field will show in the data tables output.	true or false	no	true
multiple	If this field should collect multiple values, creating an array of values.	true or false	no	false
protected	If the value of this field should be shown to the end user via API once it is saved.	true or false	no	false
clearOnHide	If the value of this field should be cleared when it is conditionally hidden.	true or false	no	true
unique	Validates if this field should be unique amongst other submissions in the same form.	true or false	no	false
persistent	Determines if the value of this field should be saved as persistent.	true or false	no	true
hidden	Determines if this field should be hidden from view by default. This can be overridden with the conditionals.	true or false	no	false
validate	Determines validation criteria for this component	Object with the following properties. required - If the field is required	no	{required: false}

Below is a list of all Form Components and the JSON schema specification for each component. The following components are allowed.

• Address
• Button
• Checkbox
• Columns
• Container
• Content
• Currency
• Custom
• DataGrid
• DateTime
• Day
• Email
• FieldSet
• File
• Form
• Hidden
• HTML Element
• Number
• Panel
• Password
• Phone Number
• Radio
• Resource
• Select
• Select Boxes
• Signature
• Survey
• Table
• TextArea
• TextField
• Time
• Well