Skip to main content

Outline

This component is suitable for use when creating accessible courses.

The Checkbox Group component is an interactive component that lets you allow learners to select one or more options from a checkbox group.

This article provides an overview of the Checkbox Group component, component setup and behavior, and provides examples of Checkbox Group component configurations.

Component overview


The Checkbox Group component is an interactive component that lets your learners select one or more options from a checkbox group. The Checkbox Group component is flexible, and with the configuration set to Allow Editing, the learner can edit their submitted answer after submitting an answer. The submitted answer can also be saved to different variables, as needed.

The Checkbox Group component is fully responsive.

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:

Screenshot showing General settings

Add Title, or a Display Title, as needed. Display Title is seen by learners.

Screenshot showing General settings

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

Screenshot showing General settings
  1. Add Instruction Text that tells users how to use the component.
  2. Include an Aria Label for screen readers, as needed.

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 Checkbox Group component. This widget can display an icon and label prior to the Checkbox Group component completion, which changes to a different icon and label once the Checkbox Group component is completed.

Checkbox Group section


Screenshot showing Checkbox Group settings
  1. In the Checkbox Group section, you set the number of Columns to your Checkbox Group component. By default, this is set to three columns for desktops, two columns for tablets, and one column for mobiles.
  2. Enter a number for Minimum Checked Options that must be checked before submitting the component. By default, this is set to 0.
  3. Enter Submit Button Text that will be shown on the submit button.
  4. Enter Submitted Label Text that will be displayed once the button has been clicked.
  5. Toggle to Allow Editing. Enabling this setting allows the learner to edit the answer after submitting it.
  6. Enter Edit Button text, as needed.

Component Examples


The Checkbox Group component gives you a lot of flexibility. Below are examples that illustrate the Checkbox Group component setup:

Example 1 – displays the Checkbox Group component before one or more options have been selected and submitted.

Example 2 – displays the Checkbox Group component after submitting an answer. The Submitted Label Text is shown, and in this example, the setting Allow Editing is enabled, and the Edit Button is displayed below the component.

Checkbox Options section


Screenshot showing Checkbox Options settings

In the Checkbox Options section, you Add Checkbox Options to your Checkbox Group component.

Screenshot showing Checkbox Options settings

For each Checkbox Option:

  1. Enter Option Text. This is the text displayed for the Checkbox Option.
  2. Toggle to enable Save Checked State to Variable. Select Variable or Create Variable for the specific Checkbox Option. By default, this setting is disabled.

Note: It is possible to enable or disable Save Checked State to Variable for each single Checkbox Option.

Add, duplicate, or delete Checkbox Options as needed.

Did this article help?

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