Single Checkbox Component

UDesigner

Classic Designer

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.

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 (Tooltip) icon. Tooltips can display across more than one line.
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 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).

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).
Input Behavior	Controls how end-users interact with the component. Choose from the following options: Enable User Input: Allow end-users to view and enter data in this field. Disable User Input: Prevents end-users from entering data in the field, but lets them view it. In the Module Builder, the field’s background displays as gray. In Express View, when end-users hover over the field, their cursor displays with a prohibited symbol. Read Only - Legacy: Prevents end-users from entering data and replaces the field with the component’s data value. If no value is provided, the component displays `None`. Read Only - Accessible: Makes the field non-editable and applies the `readonly` HTML attribute, which notifies screen readers that the field cannot be modified.

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).

Input Behavior

Controls how end-users interact with the component. Choose from the following options:

Enable User Input: Allow end-users to view and enter data in this field.
Disable User Input: Prevents end-users from entering data in the field, but lets them view it. In the Module Builder, the field’s background displays as gray. In Express View, when end-users hover over the field, their cursor displays with a prohibited symbol.
Read Only - Legacy: Prevents end-users from entering data and replaces the field with the component’s data value. If no value is provided, the component displays None.
Read Only - Accessible: Makes the field non-editable and applies the readonly HTML attribute, which notifies screen readers that the field cannot be modified.

Data Panel

Data Storage

Setting	Description
Store Data in Database	The Store Data in Database setting affects how data persists through your application. When set to (ON), Unqork stores values entered into the field to the database (server-side submission). This occurs in three scenarios: Navigating between Panels in a Navigation component. On navigation between pages (Panels), the component’s value saves to the database. Triggering a module save event using a Button component with an Action Type of Save. Navigating between screens of a workflow. On navigation between screens, the component’s value saves to the database. By default, workflows persist data from all fields in the client-side submission when navigating between screens. However, only values from fields with Store Data in Database enabled store in the server-side submission. Set the toggle to (OFF) when you don’t want to store the values from this field in the database. When using a Plug-In to remote execute a module, ensure data moving between modules is persistent. You can optionally enable Store Data in Database for components in the source module. But any components in the API module whose values are included in an API response must have Store Data in Database enabled. When a component’s data is not persistent, the data isn't included in an API call's response. So, Plug-Ins or external services requesting data from the API module can't receive non-persistent data in the response. Store Data in Database also affects what data is tracked using Unqork’s built-in tracker. When the Enable Tracker and Track Value toggles are set to (ON) in Module Settings, only values from fields with Store Data in Database enabled are tracked.

Setting

Description

Store Data in Database

The Store Data in Database setting affects how data persists through your application. When set to (ON), Unqork stores values entered into the field to the database (server-side submission). This occurs in three scenarios:

Navigating between Panels in a Navigation component. On navigation between pages (Panels), the component’s value saves to the database.
Triggering a module save event using a Button component with an Action Type of Save.
Navigating between screens of a workflow. On navigation between screens, the component’s value saves to the database.
By default, workflows persist data from all fields in the client-side submission when navigating between screens. However, only values from fields with Store Data in Database enabled store in the server-side submission.

Set the toggle to (OFF) when you don’t want to store the values from this field in the database.

When using a Plug-In to remote execute a module, ensure data moving between modules is persistent. You can optionally enable Store Data in Database for components in the source module. But any components in the API module whose values are included in an API response must have Store Data in Database enabled. When a component’s data is not persistent, the data isn't included in an API call's response. So, Plug-Ins or external services requesting data from the API module can't receive non-persistent data in the response.

Store Data in Database also affects what data is tracked using Unqork’s built-in tracker. When the Enable Tracker and Track Value toggles are set to (ON) in Module Settings, only values from fields with Store Data in Database enabled are tracked.

Actions Panel

Triggers

Setting	Description
Trigger	To set up a trigger, enter the Property ID of your chosen logic component into this field. When the end-user performs an action on the current component, the triggered component fires.

Validation Panel

User Input

Setting	Description
Required	When set to (ON), the end-user must enter a value in the component's visible fields. When set to (OFF), the input is optional. By default, Required is set to (OFF).
Required Error Message	A custom error message that displays below a required field. The error message displays when the end-user tries to save or submit the module without completing the required field.

Setting

Description

Required

When set to (ON), the end-user must enter a value in the component's visible fields. When set to (OFF), the input is optional.

By default, Required is set to (OFF).

Required Error Message

A custom error message that displays below a required field. The error message displays when the end-user tries to save or submit the module without completing the required field.

Advanced Panel

Additional Styling

Setting	Description
Custom CSS Class	Enter a Custom CSS Class to apply to your component. Custom CSS lets you maintain a consistent look and feel when the field or element is part of a template or multiple modules. Updated CSS styling applies to all components that reference this custom class name.

Setting

Description

Custom CSS Class

Enter a Custom CSS Class to apply to your component. Custom CSS lets you maintain a consistent look and feel when the field or element is part of a template or multiple modules.

Updated CSS styling applies to all components that reference this custom class name.

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.

In the Module Builder, drag and drop a Single Checkbox component onto your canvas.
In the Property ID field, enter agree.
In the Label Text field, enter Select this box if you agree to the terms and conditions.
Navigate to the component's Actions settings.
In the Trigger field, enter ruleAgree. This triggered component will be configured in a later step.
Navigate to the component's Validation settings.
Set Required to (ON).
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.

Drag and drop a Decisions component onto your canvas, placing it below the agree Single Checkbox component.
In the Property ID field, enter ruleAgree.
In the Canvas Label Text field, enter ruleAgree.
Navigate to the component's Actions settings.
In the Inputs table, enter the following:
Source
Alias
Type
Required
Silent
1
agree
exact
(Checked)
☐ (Unchecked)
In the Outputs table, enter the following:
Source
Type
1
btnSubmit
visible
In the Conditionals table, enter the following:
agree
btnSubmit_visible
1
true
yes
2
false
no
Click Save Component.

	Source	Alias	Type	Required	Silent
1	agree		exact	(Checked)	☐ (Unchecked)

	Source	Type
1	btnSubmit	visible

	agree	btnSubmit_visible
1	true	yes
2	false	no

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.

Drag and drop a Button component onto your canvas, placing it below the ruleAgree Decisions component.
In the Property ID field, enter btnSubmit.
Set Hide Field to (ON).
Click Save Component.
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

Modify the Single Checkbox component using the toolbar settings.

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 find the Single Checkbox component in the Primary Fields group to the left of the Module Builder.

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.

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 (Tooltip) icon. Tooltips can display across more than one line.
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 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).
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).
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).
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).

Data Panel

Data Storage

Setting	Description
Store Data in Database	The Store Data in Database setting affects how data persists through your application. When set to (ON), Unqork stores values entered into the field to the database (server-side submission). This occurs in three scenarios: Navigating between Panels in a Navigation component. On navigation between pages (Panels), the component’s value saves to the database. Triggering a module save event using a Button component with an Action Type of Save. Navigating between screens of a workflow. On navigation between screens, the component’s value saves to the database. By default, workflows persist data from all fields in the client-side submission when navigating between screens. However, only values from fields with Store Data in Database enabled store in the server-side submission. Set the toggle to (OFF) when you don’t want to store the values from this field in the database. When using a Plug-In to remote execute a module, ensure data moving between modules is persistent. You can optionally enable Store Data in Database for components in the source module. But any components in the API module whose values are included in an API response must have Store Data in Database enabled. When a component’s data is not persistent, the data isn't included in an API call's response. So, Plug-Ins or external services requesting data from the API module can't receive non-persistent data in the response. Store Data in Database also affects what data is tracked using Unqork’s built-in tracker. When the Enable Tracker and Track Value toggles are set to (ON) in Module Settings, only values from fields with Store Data in Database enabled are tracked.

Setting

Description

Store Data in Database

Navigating between Panels in a Navigation component. On navigation between pages (Panels), the component’s value saves to the database.
Triggering a module save event using a Button component with an Action Type of Save.
Navigating between screens of a workflow. On navigation between screens, the component’s value saves to the database.
By default, workflows persist data from all fields in the client-side submission when navigating between screens. However, only values from fields with Store Data in Database enabled store in the server-side submission.

Set the toggle to (OFF) when you don’t want to store the values from this field in the database.

When using a Plug-In to remote execute a module, ensure data moving between modules is persistent. You can optionally enable Store Data in Database for components in the source module. But any components in the API module whose values are included in an API response must have Store Data in Database enabled. When a component’s data is not persistent, the data isn't included in an API call's response. So, Plug-Ins or external services requesting data from the API module can't receive non-persistent data in the response.

Store Data in Database also affects what data is tracked using Unqork’s built-in tracker. When the Enable Tracker and Track Value toggles are set to (ON) in Module Settings, only values from fields with Store Data in Database enabled are tracked.

Actions Panel

Triggers

Setting	Description
Trigger	To set up a trigger, enter the Property ID of your chosen logic component into this field. When the end-user performs an action on the current component, the triggered component fires.

Validation Panel

User Input

Setting	Description
Required	When set to (ON), the end-user must enter a value in the component's visible fields. When set to (OFF), the input is optional. By default, Required is set to (OFF).
Required Error Message	A custom error message that displays below a required field. The error message displays when the end-user tries to save or submit the module without completing the required field.

Setting

Description

Required

When set to (ON), the end-user must enter a value in the component's visible fields. When set to (OFF), the input is optional.

By default, Required is set to (OFF).

Required Error Message

A custom error message that displays below a required field. The error message displays when the end-user tries to save or submit the module without completing the required field.

Advanced Panel

Additional Styling

Setting	Description
Custom CSS Class	Enter a Custom CSS Class to apply to your component. Custom CSS lets you maintain a consistent look and feel when the field or element is part of a template or multiple modules. Updated CSS styling applies to all components that reference this custom class name.

Setting

Description

Custom CSS Class

Enter a Custom CSS Class to apply to your component. Custom CSS lets you maintain a consistent look and feel when the field or element is part of a template or multiple modules.

Updated CSS styling applies to all components that reference this custom class name.

Adding a Single Checkbox Component

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.

In the Module Builder, drag and drop a Single Checkbox component onto your canvas.
In the Property ID field, enter agree.
In the Label Text field, enter Select this box if you agree to the terms and conditions.
In the component's configuration menu, select Actions.
In the Trigger field, enter ruleAgree. This triggered component will be configured in a later step.
In the component's configuration menu, select Validation.
Set Required to (ON).
Click Save & Close.

Configure the Decisions Component

Drag and drop a Decisions component onto your canvas, placing it below the agree Single Checkbox component.
In the Property ID field, enter ruleAgree.
In the Canvas Label Text field, enter ruleAgree.
In the component's configuration menu, select Actions.
In the Inputs table, enter the following:
Property ID
Alias
Type
Required
Silent
1
agree
exact
(Checked)
☐ (Unchecked)
In the Outputs table, enter the following:
Property ID
Type
1
btnSubmit
visible
In the Micro Decisions table, enter the following:
Input Values
Output Values
agree
btnSubmit_visible
1
true
yes
2
false
no
Click Save & Close.

	Property ID	Alias	Type	Required	Silent
1	agree		exact	(Checked)	☐ (Unchecked)

	Property ID	Type
1	btnSubmit	visible

	Input Values	Output Values
	agree	btnSubmit_visible
1	true	yes
2	false	no

Configure the Button Component

Drag and drop a Button component onto your canvas, placing it below the ruleAgree Decisions component.
In the Property ID field, enter btnSubmit.
Set Hide Field to (ON).
Click Save & Close.
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

Modify the Single Checkbox component using the toolbar settings.