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.inputMaskType | enum |
|
options.inputMask | string | A regular expression that the input must match to be considered valid |
JSON example
{ "name": "Text", "displayText": "Text Field", "description": "Description what the field is for", "type": "Textbox", "options": { "required": true, "placeholder": "Placeholder text" } }