Survey Component

This component is suitable for use when creating accessible courses.

Admins can use the Survey component to gauge learner's opinions and choices for specific topics.

This article provides an overview of the Survey component, component setup, and behavior.

Component overview

The Survey component is an interactive component where learners explain their thoughts on specific topics. The component also allows learners to choose between different options and give a rating, both in response to a question.

The Survey component is flexible and can be set to complete when the Survey is submitted. The Survey component can be configured with dialogue options if ratings are enabled and different appearance styles.

Component set up

To add this component, follow the steps in this article:

The Property Panel for the newly added component will then open automatically for you to customize set-up.

Or click anywhere on an existing component to open the Property Panel.

General section

In the General section, add Title, or a Display Title, as needed. Display Title is seen by learners.

Scroll down and add your Survey Body. Use the text editor to style and format your text, as needed.

1. Add Instruction text that tells users how to use the component.
2. Include an ARIA Label for screen readers, as needed.
3. Customize Submit Survey Button text.

Interaction Label section

In the Interaction Label section, you can enable an Interaction Label.

The Interaction Label allows you to add a widget before or after the Survey component. This widget can display an icon and label prior to the Survey component completion, which changes to a different icon and label once the Survey component is completed.

Survey Options

Survey Fields section

1. In the Survey Fields section, select Add Survey Field to create a survey field.
2. Add a Field Name identifier, as needed. This isn't visible to the learner.
3. Add a Field Placeholder, as needed. This preset text will disappear when the learner types in the field and will reappear if the learner deletes their text.
4. Add a Field Label that appears at the top left of the survey field.

Duplicate or delete a survey field, as needed.

Options section

1. In the Options section, add an Options Label, as needed.
2. Toggle Show Checkbox Icon On Options? to add visual clarity when a learner is selecting an option.
3. Select Add Survey Option to create a survey option.
4. Add an Option Name, as needed. This isn't visible to the learner.
5. Add the identifying text for the Option.

Duplicate or delete a survey option, as needed.

Ratings section

1. In the Ratings section, toggle Enable Ratings? to include a rating query in the survey.
2. Add a Ratings Label, as needed.
3. For the One Star through Five Star fields, add a descriptor to explain what each star rating means.

Dialogs section

The settings in the Dialogs section are applicable only if Ratings are enabled.

If the learner has not selected a rating before submitting the survey, you can modify the popup text that instructs the learner to select a rating before proceeding.

Change the heading of the popup text in No Rating Dialog title and the body of the popup text in No Rating Dialog Body. Change the text of the No Rating Dialog Close Button as needed.

If the learner has selected a rating before submitting the survey, you can modify the popup text that informs the learner that the survey has been successfully submitted.

Change the heading of the popup text in Success Dialog title and the body of the popup text in Success Dialog Body. Change the text of the Success Dialog Close Button as needed.

Complete State section

In the Complete State section, you can modify the Complete text and Complete Icon that appear when the survey is successfully submitted.

Appearance section

The settings in the Appearance section are applicable only if Ratings are enabled.

Modify the Star Color and Selected Star Color by selecting the square icon under each setting and choosing a color before selecting Save.

Did this article help?

Let us know by leaving a star rating or review at the top of this article.