Form Dialog

The form dialog defined the form fields and field types as well as the look and feel including labels.

A form dialog is defined by a JSON object that can look something like this:

{ "title": "Order product", "description": "A *markdown* description of the order product operation", "submitText": "Order", "pages": [ { "label": "Product", "fields": [ { "name": "product", "displayText": "Product", "description": "The product to order", "type": "Textbox", "options": { "required": true, "placeholder": "Placeholder text" } }, { "name": "Price", "displayText": "Price", "description": "Price in €", "type": "Number", "defaultValue": 12300, "options": { "required": true, "placeholder": "12.300,00€", "currencyCode": "EUR", "maximumFractionDigits": 3 } } ] } ] }

Form configuration options

Full list of top-level form configuration options:

Name

Type

Description

Name

Type

Description

title

string

The title of the form

description

string

A short string describing the purpose of this form

errorMessage

string

An error to be shown if the backend throws an error upon form submission

submitText

string

The label text for the submit button

successMessage

string

A string that will be shown if the form is successfully submitted

modal

boolean

Whether this form should be opened inside a modal, as opposed to on its own page

options

object

Additional field options (see below)

pages

array

The form pages, see https://portrait.atlassian.net/wiki/spaces/PA/pages/860422145

Copyright Treskon GmbH.