Skip to content
Formspace Docs

Form Root Schema Properties

The root form object that contains all pages, questions, and global configuration.

Element type: survey Key properties: 28

Generation Hints

Section titled “Generation Hints”
  • Aliases: form schema root, survey JSON, complete form.
  • Use when: creating or updating the top-level form object.
  • Recommended properties: title, description, showQuestionNumbers, pages, calculatedValues, triggers.
{ "title": "Client intake", "showQuestionNumbers": "off", "pages": [{ "name": "page1", "elements": [] }] }

Usage Notes

Section titled “Usage Notes”
  • Use the root object for global form configuration and the pages array.
  • Use Page and Panel for nested layout objects.
  • Use Calculated Value and Trigger for root-level computed behavior.

Key Properties

Section titled “Key Properties”

title

Section titled “title”
  • Type: string
  • Default: —
  • Localizable: Yes

A title for the form element. If title is undefined, the name property value is displayed instead.

description

Section titled “description”
  • Type: text
  • Default: —
  • Localizable: Yes

Explanatory text displayed under the title.

pages

Section titled “pages”
  • Type: surveypages
  • Default: —

Returns an array of all pages in the survey.

showQuestionNumbers

Section titled “showQuestionNumbers”
  • Type: string
  • Default: "off"
  • Allowed values: on, onPage, recursive, off

Specifies whether to display form element numbers and how to calculate them.

showNavigationButtons

Section titled “showNavigationButtons”
  • Type: boolean
  • Default: true

Gets or sets the visibility of the Start, Next, Previous, and Complete navigation buttons.

This property does not control progress saving in Formspace. To let respondents save and continue later, use Progress saving in the form’s Publish → Settings panel instead.

showProgressBar

Section titled “showProgressBar”
  • Type: boolean
  • Default: false

Specifies the visibility of the progress bar.

progressBarLocation

Section titled “progressBarLocation”
  • Type: string
  • Default: "auto"
  • Allowed values: auto, aboveheader, belowheader, bottom, topbottom

Specifies the alignment of the progress bar. Applies only if the showProgressBar property is true.

showCompletePage

Section titled “showCompletePage”
  • Type: boolean
  • Default: true

Specifies whether to show the complete page.

completedHtml

Section titled “completedHtml”
  • Type: html
  • Default: —
  • Localizable: Yes

HTML content displayed on the complete page.

completeText

Section titled “completeText”
  • Type: string
  • Default: —
  • Localizable: Yes

Gets or sets a caption for the Complete button.

calculatedValues

Section titled “calculatedValues”
  • Type: calculatedvalues
  • Default: —

An array of calculated values.

triggers

Section titled “triggers”
  • Type: triggers
  • Default: —

A list of triggers in the survey.

clearInvisibleValues

Section titled “clearInvisibleValues”
  • Type: string
  • Default: "onComplete"
  • Allowed values: none, onComplete, onHidden, onHiddenContainer

Specifies when to remove values of invisible questions from survey results.

questionTitleLocation

Section titled “questionTitleLocation”
  • Type: string
  • Default: "top"
  • Allowed values: top, bottom, left

Gets or sets question title location relative to the input field: “top”, “bottom”, or “left”.

questionDescriptionLocation

Section titled “questionDescriptionLocation”
  • Type: string
  • Default: "underTitle"
  • Allowed values: underInput, underTitle

Specifies where to display question descriptions.

questionErrorLocation

Section titled “questionErrorLocation”
  • Type: string
  • Default: "top"
  • Allowed values: top, bottom

Specifies the error message position.

questionOrder

Section titled “questionOrder”
  • Type: string
  • Default: "initial"
  • Allowed values: initial, random

Specifies the sort order of questions in the survey.

requiredMark

Section titled “requiredMark”
  • Type: string
  • Default: "*"

Specifies one or multiple characters that designate required questions.

locale

Section titled “locale”
  • Type: string
  • Default: —
  • Allowed values: “

Specifies the survey’s locale.

Section titled “logo”
  • Type: file
  • Default: —
  • Localizable: Yes

An image URL or a Base64-encoded image to use as a survey logo.

logoPosition

Section titled “logoPosition”
  • Type: string
  • Default: "left"
  • Allowed values: none, left, right, top, bottom

A logo position relative to the survey title.

width

Section titled “width”
  • Type: string
  • Default: —

A survey width in CSS values.

widthMode

Section titled “widthMode”
  • Type: string
  • Default: "auto"
  • Allowed values: auto, static, responsive

Specifies how to calculate the survey width.

Section titled “navigateToUrl”
  • Type: string
  • Default: —

A URL to which respondents should be navigated after survey completion.

Section titled “navigateToUrlOnCondition”
  • Type: urlconditions
  • Default: —

An array of objects that allows you to navigate respondents to different URLs after survey completion.

firstPageIsStartPage

Section titled “firstPageIsStartPage”
  • Type: boolean
  • Default: false

Gets or sets a Boolean value that specifies whether the first page is a start page.

readOnly

Section titled “readOnly”
  • Type: boolean
  • Default: —

Enables the read-only mode. If you set this property to true, users cannot take the survey.

textUpdateMode

Section titled “textUpdateMode”
  • Type: string
  • Default: "onBlur"
  • Allowed values: onBlur, onTyping

Specifies when to update the question value in questions with a text input field.