form-definition-schema-properties-pages-pages-item
Items Type
object (Pages Item)
items Properties
| Property | Type | Required | Nullable | Defined by |
|---|---|---|---|---|
| id | string | Optional | cannot be null | Form Definition Schema |
| path | Merged | Required | cannot be null | Form Definition Schema |
| title | string | Required | cannot be null | Form Definition Schema |
| section | string | Optional | cannot be null | Form Definition Schema |
| controller | string | Optional | cannot be null | Form Definition Schema |
| components | array | Optional | cannot be null | Form Definition Schema |
| repeat | object | Optional | cannot be null | Form Definition Schema |
| condition | string | Optional | cannot be null | Form Definition Schema |
| next | array | Optional | cannot be null | Form Definition Schema |
| events | object | Optional | cannot be null | Form Definition Schema |
| view | string | Optional | cannot be null | Form Definition Schema |
id
Unique identifier for the page
id
-
is optional
-
Type:
string(Id) -
cannot be null
-
defined in: Form Definition Schema
Id Type
string (Id)
id Constraints
UUID: the string must be a UUID, according to RFC 4122
path
URL path for this page, must not be the reserved "/status" path
path
-
is required
-
Type:
string(Path) -
cannot be null
-
defined in: Form Definition Schema
Path Type
string (Path)
not
title
Page title displayed at the top of the page
title
-
is required
-
Type:
string(Title) -
cannot be null
-
defined in: Form Definition Schema
Title Type
string (Title)
section
Section this page belongs to
section
-
is optional
-
Type:
string(Section) -
cannot be null
-
defined in: Form Definition Schema
Section Type
string (Section)
controller
Custom controller class name for special page behavior
controller
-
is optional
-
Type:
string(Controller) -
cannot be null
-
defined in: Form Definition Schema
Controller Type
string (Controller)
components
UI components displayed on this page
components
-
is optional
-
Type:
object[](Components Item) -
cannot be null
-
defined in: Form Definition Schema
Components Type
object[] (Components Item)
components Constraints
unique items: all items in this array must be unique. Duplicates are not allowed.
repeat
Configuration for repeatable pages, used with RepeatPageController. Defines how repeatable sections behave including min/max repetitions and display options.
NOTE: This configuration is only used when the 'controller' property is set to 'RepeatPageController'. Otherwise, this property should not be specified.
repeat
-
is optional
-
Type:
object(Repeat Configuration) -
cannot be null
-
defined in: Form Definition Schema
Repeat Type
object (Repeat Configuration)
condition
Optional condition that determines if this page is shown
condition
-
is optional
-
Type:
string(Condition) -
cannot be null
-
defined in: Form Definition Schema
Condition Type
string (Condition)
next
Possible navigation paths after this page
next
-
is optional
-
Type:
object[](Next Item) -
cannot be null
-
defined in: Form Definition Schema
Next Type
object[] (Next Item)
next Default Value
The default value is:
[]events
Event handlers for page lifecycle events
events
-
is optional
-
Type:
object(Events) -
cannot be null
-
defined in: Form Definition Schema
Events Type
object (Events)
view
Optional custom view template to use for rendering this page
view
-
is optional
-
Type:
string(View) -
cannot be null
-
defined in: Form Definition Schema
View Type
string (View)