Skip to content

Components JSON Schema

Travis Tidwell edited this page Jun 30, 2017 · 19 revisions

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. Below is a list of all Form Components and the JSON schema specification for each component.

Textfield

The textfield component renders a <input type="text" /> input.

Example

{
  "type": "textfield",
  "label": "First Name",
  "key": "firstName",
  "inputType": "text"
}

JSON Spec

Property Description Value required
type The type of component. textfield yes
label The label to add to the component. any string no
key The API key to provide for this field. This is used as the submission data keys. any camel-cased string yes
inputType The type of input this field is. The value of this is provided to the <input type="[inputType]" /> parameter. Any standard HTML input type yes
Clone this wiki locally