Skip to main content

betaThis is a new capability. Help us improve it and give your feedback on Slack.

form-definition-v2-schema-properties-pages-pages-item

Items Type

object (Pages Item)

items Properties

PropertyTypeRequiredNullableDefined by
pathMergedRequiredcannot be nullForm Definition V2 Schema
sectionstringOptionalcannot be nullForm Definition V2 Schema
controllerstringOptionalcannot be nullForm Definition V2 Schema
repeatobjectOptionalcannot be nullForm Definition V2 Schema
nextarrayOptionalcannot be nullForm Definition V2 Schema
eventsobjectOptionalcannot be nullForm Definition V2 Schema
viewstringOptionalcannot be nullForm Definition V2 Schema
idstringOptionalcannot be nullForm Definition V2 Schema
titlestringRequiredcannot be nullForm Definition V2 Schema
componentsMergedOptionalcan be nullForm Definition V2 Schema
conditionstringOptionalcannot be nullForm Definition V2 Schema

path

URL path for this page, must not be the reserved "/status" path

path

Path Type

string (Path)

not

section

Section this page belongs to

section

Section Type

string (Section)

controller

Custom controller class name for special page behavior

controller

Controller Type

string (Controller)

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

Repeat Type

object (Repeat Configuration)

next

Possible navigation paths after this page

next

Next Type

object[] (Next Item)

next Default Value

The default value is:

[]

events

Event handlers for page lifecycle events

events

Events Type

object (Events)

view

Optional custom view template to use for rendering this page

view

View Type

string (View)

id

Unique identifier for the page

id

Id Type

string (Id)

id Constraints

UUID: the string must be a UUID, according to RFC 4122

title

Page title displayed at the top of the page (with support for empty titles in V2)

title

Title Type

string (Title)

components

The components value.

components

Components Type

any of the following: array or boolean or number or object or string (Components)

any of

condition

Optional condition that determines if this page is shown

condition

Condition Type

string (Condition)

condition Constraints

constant: the value of this property must be equal to:

{
"ref": {
"path": [
"conditions"
],
"ancestor": "root",
"in": true
}
}