Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Field options

...

Name

Type

Description

name

string

The name by which the field will internally be referenced

displayText

string

The main field label displayed above the field

description

string

An additional description displayed below the main label

defaultValue

string

The value the field should initially be filled with

options

object

Additional field options (see below)

options.required

boolean

Whether the field must be filled to advance

options.readOnly

boolean

Whether it’s allowed to change the field value

options.confirmation

boolean

Whether to include this field in the confirmation page

options.maxCount

number

How many images are allowed to be uploaded

options.maxSize

number

The maximum file size of each file, in bytes

options.acceptedFileTypes

array

Array of strings of MIME-types of accepted files

JSON Example

Code Block
{
  "name": "File",
  "displayText": "File upload",
  "description": "Upload a file",
  "type": "File",
  "options": {
    "acceptedFileTypes": ["application/pdf", "application/zip"],
    "required": true,
    "maxCount": 1
  }
}