Skip to main content

Survey

The Survey component facilitates the creation of questionnaire-style inputs within a form. It supports multiple question types and response options, enabling the collection of structured feedback or data from users.

Survey

The options available to configure the Survey component are separated into four categories:

  • Display
  • Data
  • Validation
  • Conditional

Display

ParameterDescription
LabelText label that appears next to the input field.
DescriptionAdditional guidance text shown below the input.
TooltipHelper text displayed on hover for quick hints.
Custom CSS ClassPattern used to format user input visually as they type.
AutocompleteEnables or disables browser autocomplete suggestions.
HiddenKeeps the component data but hides it from the user view.
Hide LabelHides the field label on the rendered form.
Initial FocusSets this field as the first one focused when the form loads.
DisabledPrevents the user from editing the input field.

Data

ParameterDescription
QuestionsDefines a list of options for fields that collect question-based input (e.g., survey items). Each entry includes:
- Label: The text shown to users as the question.
- Value: The internal value stored when this question is selected.
- Tooltip: A small helper message shown when hovering over an info icon.
ValuesDefines the available answers or options corresponding to the questions. Each entry includes:
- Label The text shown to users as the answer option.
- Value The actual value submitted/stored when this answer is selected.
- Tooltip Optional helper text shown to explain the answer choice.
Default ValuePre-populates the field with a default value when the form loads. Note that this will override the placeholder text.
Clear Value When HiddenAutomatically clears the field's value if the component becomes hidden.

Validation

ParameterDescription
RequiredMakes this field mandatory before form submission.
UniqueEnsures the entered value has not been submitted before.
Validate When HiddenValidates the field even when it’s not visible on the form.
Error LabelCustom label shown when a validation error occurs.
Custom Error MessageDisplays a personalized message when the field fails validation.

Conditional

ParameterDescription
This Component should displayTrue - the component will display in the form.
False - the component will not display.
When the form componentSelect what component within the form will execute the condition. For example, Submit.
Has the valueThe data entry of the field that executes the condition.