Advanced Input Options Reference
| Option | Type | Description | Default |
|---|---|---|---|
|
required |
boolean |
Field is required |
false |
|
options.checkboxType |
string |
Values must be unique |
false |
|
options.checkboxOptions |
string |
Maximum character length |
0 (unlimited) |
|
options.defaultSelected |
string |
Maximum character length |
– |
|
options.minChoices |
number |
Validation pattern |
“” |
|
options.maxChoices |
string |
Pre-filled value |
“” |
|
options.layout |
string |
Placeholder text |
“” |
|
options.customErrorMessage |
string |
Custom error message |
“” |
|
options.fieldNote |
string |
Helpful note displayed below field |
“” |
|
private |
boolean |
Hide from API |
false |
Example Usage
{
"required": true,
"maxLength": 255,
"minLength": 3,
"regex": "^[a-zA-Z0-9\\s]+$",
"options": {
"customErrorMessage": "Please enter valid text",
"placeholder": "Enter your text here",
"defaultValue": "Default text",
"fieldNote": "This field accepts alphanumeric characters and spaces only"
}
}Advanced Checkbox Options Reference
| Option | Type | Description | Default |
|---|---|---|---|
|
required |
boolean |
Field is required |
false |
|
options.checkboxType |
string |
single or multiple |
single |
|
options.checkboxOptions |
string |
Options in value|label format |
“” |
|
options.defaultSelected |
string |
Pre-selected options |
“” |
|
options.minChoices |
number |
Minimum selections |
– |
|
options.maxChoices |
number |
Maximum selections |
– |
|
options.layout |
string |
vertical, horizontal, or grid |
vertical |
|
options.customErrorMessage |
string |
Custom error message |
“” |
|
options.fieldNote |
string |
Helpful note displayed below field |
“” |
|
private |
boolean |
Hide from API |
false |
Advanced Radio Options Reference
| Option | Type | Description | Default |
|---|---|---|---|
|
required |
boolean |
Field is required |
false |
|
options.selectionType |
string |
single or multiple |
single |
|
options.radioOptions |
string |
Options in value|label format |
“” |
|
options.defaultSelected |
string |
Pre-selected options |
“” |
|
options.minChoices |
number |
Minimum selections |
– |
|
options.maxChoices |
number |
Maximum selections |
– |
|
options.layout |
string |
vertical, horizontal, or grid |
vertical |
|
options.customErrorMessage |
string |
Custom error message |
“” |
|
options.fieldNote |
string |
Helpful note displayed below field |
“” |
|
private |
boolean |
Hide from API |
false |
Advanced Enumeration Options Reference
| Option | Type | Description | Default |
|---|---|---|---|
|
required |
boolean |
Field is required |
false |
|
options.enumOptions |
string |
Options in value|label format |
“” |
|
options.defaultSelected |
string |
Pre-selected options |
“” |
|
options.minChoices |
number |
Minimum selections |
– |
|
options.maxChoices |
number |
Maximum selections |
– |
|
options.customErrorMessage |
string |
Custom error message |
“” |
|
options.fieldNote |
string |
Helpful note displayed below field |
“” |
|
private |
boolean |
Hide from API |
false |
Advanced Color Options Reference
| Option | Type | Description | Default |
|---|---|---|---|
|
required |
boolean |
Field is required |
false |
|
options.format |
string |
Display format: hex, rgb, or hsl |
hex |
|
options.alpha |
boolean |
Enable transparency (alpha channel) |
false |
|
options.defaultValue |
string |
Pre-selected color value |
“” |
|
options.palette |
string |
Preset colors, one per line |
“” |
|
options.allowCustom |
boolean |
Allow values outside the preset palette |
true |
|
options.customErrorMessage |
string |
Custom validation message |
“” |
|
options.fieldNote |
string |
Helpful note displayed below field |
“” |
|
private |
boolean |
Hide from API |
false |
Example Usage
{
"required": true,
"options": {
"format": "rgb",
"alpha": true,
"defaultValue": "rgba(30, 144, 255, 1)",
"palette": "#000000\n#ffffff\n#1e90ff\n#ff4757",
"allowCustom": true,
"fieldNote": "Prefer brand colors when available"
}
}