Single Checkbox Component

Overview
The Single Checkbox component presents your end-user with a single option for selection. Below are some examples when using this component:
-
Select this checkbox to confirm you are at least 18 years old.
-
I've read and agree to the terms of use.
-
Shipping address is the same as the billing address.
You can set a checkbox as required or leave it optional. You might require it if you want the end-user's consent before they proceed. For example, using a required checkbox for Age Verification and Terms of Use consent.
You can also set a Single Checkbox component to trigger an action. Take the above example of Shipping Address is the same as Billing Address. A field might autofill with the end-user's shipping information if they select the checkbox.
You can find the Single Checkbox component in the Primary Fields group to the left of the Module Builder.
What You'll Learn
After completing this article, you’ll know when to use a Button component, how to configure its settings, and how to use it in an Unqork application.
About the Configuration Window
To learn more about general component settings and those that display when a component is associated with Data Models, view our General Component Settings article.
Display Panel
Field Text
Setting |
Description |
---|---|
Label Text |
Label Text conveys what the input component is and what information it displays. Enter the purpose of the corresponding component or field. User-friendly labels make your module more accessible. Keep labels short and descriptive (a word or two) using title case. For longer entries, use sentence case. |
Contextual Help
Setting |
Description |
---|---|
Tooltip |
A short hint that displays when an end-user positions their cursor over the |
Helper Text |
A quick tip describing the expected value of an input field. Unlike a Tooltip, Helper Text stays visible under the input field and displays on a single line. |
Default State Options
Setting |
Description |
---|---|
Hide Label |
Setting the Hide Label to (ON) hides Label Text from displaying in Express View. Your Label Text still displays in the Module Builder. By default, this setting is set to (OFF). |
Disable User Input |
When set to (ON), end-users cannot interact with or edit the Express View's input field or element. When end-users hover over the field, their cursor changes to alert them to the status change. By default, Disable User Input is set to (OFF). |
Read Only View |
When set to (ON), the component is display-only. If another component sends content to the field, the end-user can view that content. Otherwise, end-users see the word None. By default, the Read Only View toggle is set to (OFF). |
Hide Field |
Displays or hides the component from view. Setting Hide Field to (ON) hides the component in Express View. Setting it to (OFF) displays the component. The component is always visible in the Module Builder. By default, Hide Field is set to (OFF). |
Formatting
Setting |
Description |
---|---|
Set Default Value to Checked |
When set to (ON), the checkbox is selected by default. By default, Set Default Value to Checked set to (OFF). |
Adding a Single Checkbox Component
Configure a Single Checkbox component that asks your end-user to acknowledge a set of terms and conditions. Then configure a Decisions component to display a button if the end-user agrees to the conditions.
These instructions assume that you have an open module saved with a title, and an HTML Element component set up with an agreement.
Configure the Single Checkbox Component
Set the checkbox as Required to stop the end-user from proceeding until they select the it.
1. | In the Module Builder, drag and drop a ![]() |
2. | In the Property ID field, enter agree. |
3. | In the Label Text field, enter Select this box if you agree to the terms and conditions. |
4. | Navigate to the component's Actions settings. |
5. | In the Trigger field, enter ruleAgree. This triggered component will be configured in a later step. |
6. | Navigate to the component's Validation settings. |
7. | Set Required to (ON). |
8. | Click Save Component. |
Configure the Decisions Component
The Decisions component is triggered by the Single Checkbox component to make the btnSubmit Button component visible. Add Boolean (true/false) values in the Micro Decisions table to hide the Button component when the end-user clears the Single Checkbox component.
1. | Drag and drop a ![]() ![]() |
2. | In the Property ID field, enter ruleAgree. |
3. | In the Canvas Label Text field, enter ruleAgree. |
4. | Navigate to the component's Actions settings. |
5. | In the Inputs table, enter the following: |
|
Source |
Alias |
Type |
Required |
Silent |
---|---|---|---|---|---|
1 |
agree |
|
exact |
|
☐ (Unchecked) |
6. | In the Outputs table, enter the following: |
|
Source |
Type |
---|---|---|
1 |
btnSubmit |
visible |
7. | In the Conditionals table, enter the following: |
agree | btnSubmit_visible | |
---|---|---|
1 |
true |
yes |
2 |
false |
no |
8. | Click Save Component. |
Configure the Button Component
Add a Button component, so end-users can save their submission only if they agree to the terms and conditions. Use the Hide Field setting to prevent users from saving before they check the agree Single Checkbox component.
1. | Drag and drop a ![]() ![]() |
2. | In the Property ID field, enter btnSubmit. |
3. | Set Hide Field to (ON). |
4. | Click Save Component. |
5. | Save your module. |
Once implemented, your Single Checkbox component looks like the following in Express View:
Structure of a Single Checkbox Component's Data
The data structure of a Single Checkbox component selection is a key/value pair. The key is the Property ID name of the component, and the value is stored as a Boolean value.
Resources