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.placeholder

string

A placeholder to display inside the field when it’s not filled

options.currencyCode

enum

A 3-Character currency code as defined by ISO 4217

options.maximumFractionDigits

integer

A number to restrict the maxium amount of decimal places. If currencyCode is set, this will be ignored and always be 2.

JSON Example

Code Block
{
  "name": "Price",
  "displayText": "Price",
  "description": "Price in €",
  "type": "Number",
  "defaultValue": 12300,
  "options": {
    "required": true,
    "placeholder": "12.300,00€",
    "currencyCode": "EUR",
    "maximumFractionDigits": 3
  }
}