Progress Bar

Type key: progress_bar. Shows respondents how far they are through the form, pinned to the top or bottom of the screen. In the editor this is the Progress bar.

A structural node: it sits at the page root and cannot be placed in a layout row. It does not count toward the per-page or per-form node limits.

Meta fields

The meta fields of this node type are listed in the request body of Replace the draft document, under pages › nodes, in the progress_bar tab.

Example

A minimal Progress Bar node

{
  "public_id": "nPrg",
  "sort_order": 1,
  "type": "progress_bar",
  "meta": {
    "progress_bar_style": "bar",
    "progress_bar_position": "top",
    "progress_bar_animated": true
  }
}

Defaults and rules

• A form has one progress bar, shown on every page. Add a progress_bar node to any one page and the server adds it to every other page, intro and endings included. To remove it, leave it out of every page.
• Its meta is form-wide. When pages disagree, the first progress bar in page order wins and its meta is copied to every page.
• is_hidden stays per page: set it to true to leave the bar out of that page while it keeps showing on the others.
• Copies the server adds receive new public IDs. On a later write, a page that omits the progress bar’s public_id keeps the ID it already has.
• A null setting renders the default: progress_bar_style: "segments", progress_bar_position: "top", and progress_bar_animated: true.
• The Segments and Bullets styles let respondents click back to a visited step only while allow_back_navigation is 1 in the form’s properties.