form-definition-schema-properties-pages-pages-item-properties-components-components-item-properties-options
Options Type
object (Options)
options Default Value
The default value is:
{}options Properties
| Property | Type | Required | Nullable | Defined by |
|---|---|---|---|---|
| rows | number | Optional | cannot be null | Form Definition Schema |
| maxWords | number | Optional | cannot be null | Form Definition Schema |
| maxDaysInPast | number | Optional | cannot be null | Form Definition Schema |
| maxDaysInFuture | number | Optional | cannot be null | Form Definition Schema |
| customValidationMessage | string | Optional | cannot be null | Form Definition Schema |
| customValidationMessages | object | Optional | cannot be null | Form Definition Schema |
| amount | number | Optional | cannot be null | Form Definition Schema |
| description | string | Optional | cannot be null | Form Definition Schema |
| Additional Properties | Any | Optional | can be null |
rows
Number of rows for textarea components
rows
-
is optional
-
Type:
number(Rows) -
cannot be null
-
defined in: Form Definition Schema
Rows Type
number (Rows)
maxWords
Maximum number of words allowed in text inputs
maxWords
-
is optional
-
Type:
number(Max Words) -
cannot be null
-
defined in: Form Definition Schema
Max Words Type
number (Max Words)
maxDaysInPast
Maximum days in the past allowed for date inputs
maxDaysInPast
-
is optional
-
Type:
number(Max Days In Past) -
cannot be null
-
defined in: Form Definition Schema
Max Days In Past Type
number (Max Days In Past)
maxDaysInFuture
Maximum days in the future allowed for date inputs
maxDaysInFuture
-
is optional
-
Type:
number(Max Days In Future) -
cannot be null
-
defined in: Form Definition Schema
Max Days In Future Type
number (Max Days In Future)
customValidationMessage
Custom error message for validation failures
customValidationMessage
-
is optional
-
Type:
string(Custom Validation Message) -
cannot be null
-
defined in: Form Definition Schema
Custom Validation Message Type
string (Custom Validation Message)
customValidationMessages
Custom error messages keyed by validation rule name
customValidationMessages
-
is optional
-
Type:
object(Custom Validation Messages) -
cannot be null
-
defined in: Form Definition Schema
Custom Validation Messages Type
object (Custom Validation Messages)
amount
Payment amount in GBP (£0.30 - £100,000)
amount
-
is optional
-
Type:
number(Amount) -
cannot be null
-
defined in: Form Definition Schema
Amount Type
number (Amount)
amount Constraints
maximum: the value of this number must smaller than or equal to: 100000
minimum: the value of this number must greater than or equal to: 0.3
description
Payment description (max 230 chars)
description
-
is optional
-
Type:
string(Description) -
cannot be null
-
defined in: Form Definition Schema
Description Type
string (Description)
description Constraints
maximum length: the maximum number of characters for this string is: 230
Additional Properties
Additional properties are allowed and do not have to follow a specific schema