<Root>

Localisable HTML: Error Summary intro text

Localisable PlainText: screen-reader-only content before form field error messages to give some context to error messages for screen reader users.

E.g.

{
  en: 'Error',
}

Localisable HTML: Accessibilty Compass 'Error Summary' link error content.

Rendered as a link.

E.g.

{
  en: 'Error summary',
}

Localisable HTML: Accessibilty compass next error content.

Rendered as a link.

E.g.

{
  en: 'Next Error',
}

Localisable HTML: Accessibilty compass preceding error content.

Rendered as a link.

E.g.

{
  en: 'Previous Error',
}

Localisable PlainText: describes the * symbol as required for screen readers.

Kinda like alt-text for the * message on required form fields.

E.g.

{
  en: 'Required',
}

The form builder id (optional).

Only necessary if you're loading a form from GetFormally.com.

The form builder version id (optional).

Only necessary if you're loading a form from GetFormally.com.

Localisable PlainText: describes for all users (sighted, screen reader users, etc) that the form includes required fields which are marked with the * symbol.

E.g.

{
  en: 'Required fields are marked with an *',
  mi: 'Ka tohua ngā āpure ka hiahiatia ki te *',
}

Whether to enable the prototype accessibility feature 'Accessibility Compass'.

The Accessibility Compass is displayed on form fields with errors, providing quick links to the Error Summary, any preceding error, any next error, and the submit button.

(these four axes are why it was named a compass).

Whether to send analytics to GetFormally.com or a custom onAnalytics={yourCallback} handler.

Whether to display an error summary at the top of the page.

Error Summaries make it easier to find errors by providing a list of errors in the page.

This is because if there are only a few errors in a long page it can be difficult to find them, especially for screen reader users.

Whether success page/error screens are used after a form submission.

For accessibilty reasons it's important that any headings (<h1>-<h6>) fit into the headings used in your page, including those outside of <Formally>.

The value of "auto" will detect any preceding heading and ensure headings in Formally fit. E.g. if the preceding heading is <h2> then Formally will use <h3>. If there is no preceding heading then with 'auto' Formally will use <h1>.

Leave this as "auto" unless you want to choose a specific heading level offset.

If you do wish to choose a specific heading level offset choose a number from 1-6.

Whether to hide any answers below this.

Whether to use a horizontal layout

Localisable Text: Locale picker locale names content.

{
  en: "English",
  cn: "Chinese (Mandarin)"
}

An array of the enabled locale ids for the locale picker.

If a locale isn't in this list the localisable content won't be used.

This also affects the order of locales in the Locale Picker, and the default locale if the user's browser doesn't express a preference.

E.g.

["en", "mi"]

Localisable HTML: Locale selector label content.

E.g.

{
  en: 'Select language',
  mi: 'Tīpako reo',
}

Localisable HTML: progress indicator content.

Displayed at the top of the page.

E.g.

{
  en: 'Page {pageNumber} of {totalPages}',
  mi: 'Wharāngi {pageNumber} o te {totalPages}',
}

See also the hasProgressIndicator boolean on each <Page> to enable it.

When a form was published in UTC milliseconds.

Localisable HTML: Removing an <AutoSuggest> item.

Note: This is a JSON or Form Builder feature. SDK React users should use one <ErrorPage> instead and leave this blank.

If you are using JSON or the Form Builder however then you can set either:

1) an empty array (indicating no error message at all), or;

2) An array with a single item, a string of an item id of type ErrorPage. The ErrorPage can have children of its own (Content, PopOutMessage, etc.) The ErrorPage children are displayed at the top of the Submit Page (the page with the submit button) so that a user can submit the form again. So the "Page" in "ErrorPage" is somewhat of a misnomer.

Localisable HTML: Submit button content.

Localisable HTML: While waiting for the network after a submission this content will be used (and announced in an aria-live region).

Note: This is a JSON or Form Builder feature. SDK React users should use one <SuccessPage> instead and leave this blank.

If you are using JSON or the Form Builder however then you can set either:

1) an empty array (indicating no success message at all), or;

2) An array with a single item, a string of an item id of type SuccessPage. The SuccessPage can have children of its own (Content, PopOutMessage, etc.)

When a form was updated in UTC milliseconds.

A list of tags within the document.

DOCS TODO

Arbitrary metadata on this node.

This is useful when developing custom controls as it allows you to pass down metadata/extensions.