Checkboxes Component
Overview
With a Checkboxes component, you can create a question with more than one possible answer. Checkboxes let your end-user End-users, also known as Express Users, are the individuals accessing an application through Express View. In most cases, end-users are the customers using the product. choose more than one response from your provided options. As a comparison, the Radio Buttons component only allows one selection. With a Checkboxes component, your end-user can compare all available options, selecting all that apply.
Here are some examples of checkbox questions:
-
Do you have any of the following medical conditions? Please select all that apply.
-
What sports do you play on a regular basis? Please select all that apply.
-
Which of these account types are you interested in opening? Please select all that apply.
The Checkboxes component has built-in Select All and None of the Above options. This adds more versatility to your application and prevents conflicting responses.
You can also use a Checkboxes component to trigger a Text Field component to display. Think of this as a write-in option for your end-user. For example, if none of the provided answers apply, they can select the Other box, which displays a separate text field. That way, your end-user can enter their response.
A Checkboxes component can also trigger an existing component. For example, an end-user who wants to open an account can select Retirement from a list of options. When they select the Retirement box, a new drop-down displays to select a specific account type.
You'll find the Checkboxes 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 |
|---|---|
|
Property ID |
A Property ID is the unique field ID used by Unqork to track and link components in your module. The Property ID is how the software identifies your component. Using Property IDs lets you link components, creating logic-based configurations and API APIs (application programming interfaces) are a set of protocols and definitions developers use to build and integrate application software. APIs act as the connective tissue between products and services. calls. Property IDs must use camel case A naming convention for computer programming. Use camelCase for Property IDs, for example: newUser, lastName, & rdoButton. (stylized as camelCase) without spaces or punctuation. |
|
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 |
|---|---|
|
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, the Disable User Input toggle is set to (OFF). |
|
Hide Field |
Shows or hides the component from view. Setting the Hide Field toggle to (ON) hides the component in Express View. Setting the toggle to (OFF) shows the component. The component is always visible in the Module Builder. By default, the Hide Field toggle is set to (OFF). |
Formatting
|
Setting |
Description |
|---|---|
|
Number of Columns |
The number of columns in which you want the checkboxes evenly arranged. You have the option of By default, the checkboxes align on a single column. |
(one), 
(three) columns. 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:
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. To learn more about Store Data in Database in the context of API modules, see the panelResponse Panel section of the API Specification Snippet article in our In-Product Help. 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. |
|
Promote Data to Top Level |
When set to (ON), the component's values store at the highest level of the submission data. Use this if you need responses to read true or false for each option instead of one list of all items selected. When set to (OFF), values store as one string containing all selected items. By default, the Promote Data to Top Level toggle is set to (OFF). |
Data Source Type
There are two methods that you can use to populate a Checkboxes component: Values or a Data Reference Key.
Values
Values are the simplest way to populate a Checkboxes component. When selecting the Values setting, a Values table displays. Click the Edit button to open the Values table and enter each checkbox option with its associated value.
|
Setting |
Description |
|---|---|
|
Option Label |
Each option needs an end-user End-users, also known as Express Users, are the individuals accessing an application through Express View. In most cases, end-users are the customers using the product.-facing label describing the choice that it represents. Enter your Option Labels using this column. After you create an option, another row displays for you to create the next option. |
|
Value to Store in Submission Data |
Each option needs an associated value to store in the submission data. Enter the values to store in submission data using this column. By default, the value is a camelCase A naming convention for computer programming. Use camelCase for Property IDs, for example: newUser, lastName, & rdoButton. version of the Option Label. |
Data Reference Key
With a Data Reference Key, you can use data from another component to populate your Checkboxes component. You'll most often use a Data Table component. Add your data to the Data Table and then reference it in your Checkboxes component's configuration menu.
Think of this as a hybrid when using Values and Data Collection to populate your Checkboxes component. You still use data stored in Unqork, but it's data from your module instead of a Data Collection.
| Setting | Description |
|---|---|
|
Data Reference Key |
Enter the Property ID of the component whose data you're referencing. |
|
Value Property |
If a data set includes a column for values, enter the column's name here. If not specified, the application uses the data drawn using the Label Path setting below. |
|
Label Path |
This field refers to the option labels to retrieve. If you're retrieving data from a Data Table component, enter the column header in this field. |
Pre-Configured Checkbox Selections
|
Setting |
Description |
|---|---|
|
Selection to Trigger a Component |
When set to (ON), you can add an option that triggers another component when selected. This is useful if you want the end-user to give a custom response or to elaborate on a response. This new option displays at the bottom of the list. By default, the Selection to Trigger a Component toggle is set to (OFF). |
|
Option Label |
Each option needs an end-user End-users, also known as Express Users, are the individuals accessing an application through Express View. In most cases, end-users are the customers using the product.-facing label describing the choice that it represents. Enter your Option Labels using this column. After you create an option, another row displays for you to create the next option. By default, the Selection to Trigger a Component has the Option Label of Other. |
|
Value to Store in Submission Data |
Each option needs an associated value to store in the submission data. Enter the values to store in submission data using this column. By default, the value is a camelCase A naming convention for computer programming. Use camelCase for Property IDs, for example: newUser, lastName, & rdoButton. version of the Option Label. |
|
Component to Trigger When a User Selects This Option |
Here you have the choice of triggering a new Text Field component or an existing component to display below the associated checkbox option.
|
|
Property Name of Text Field |
If you select the Text Field option, you must give the new Text Field component a Property Name. |
|
Placeholder of Text Field |
If you select the Text Field, you can enter a placeholder text to assist the end-user. |
|
Property Name of Existing Component |
If you select the Choose Existing, you can enter the Property ID A Property ID is the unique field ID used by Unqork to track and link components in your module. of an existing component in your module to trigger. |
|
Selection to Uncheck All Options |
This setting adds a new checkbox (None of the Above) that, when selected, clears all other options. With None of the Above selected, the end-user cannot make any other selections. To make another selection, they must clear None of the Above. By default, the Selection to Uncheck All Options toggle is set to (OFF). |
|
Option Label |
Each option needs an end-user End-users, also known as Express Users, are the individuals accessing an application through Express View. In most cases, end-users are the customers using the product.-facing label describing the choice that it represents. Enter your Option Labels using this column. After you create an option, another row displays for you to create the next option. By default, the Selection to Uncheck All Options has the Option Label of None of the Above. |
|
Value to Store in Submission Data |
Each option needs an associated value to store in the submission data. Enter the values to store in submission data using this column. By default, the value is a camelCase A naming convention for computer programming. Use camelCase for Property IDs, for example: newUser, lastName, & rdoButton. version of the Option Label. By default, the Selection to Uncheck All Options has a value of None. |
|
Selection to Select All Options |
This setting adds a new checkbox (Select All) that, when selected, selects all other options. This option automatically excludes the None of the Above option, if applicable. By default, the Selection to Select All Options toggle is set to (OFF). |
|
Option Label |
Each option needs an end-user End-users, also known as Express Users, are the individuals accessing an application through Express View. In most cases, end-users are the customers using the product.-facing label describing the choice that it represents. Enter your Option Labels using this column. After you create an option, another row displays for you to create the next option. By default, the Selection to Select All Options has the Option Label of Select All. |
Actions Panel
Triggers
|
Setting |
Description |
|---|---|
|
Trigger |
To set up a trigger, enter the Property ID A Property ID is the unique field ID used by Unqork to track and link components in your module. 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
Other Errors
|
Setting |
Description |
|---|---|
|
Custom Error Message |
You can set specific parameters apart from requiring the field. For example, you might only allow your end-user to select two items from the list. If they select a third item, this custom error message displays. |
User Input
|
Setting |
Description |
|---|---|
|
Required |
When set to (ON), the end-user must enter a value in the component's visible fields. Set the toggle to (OFF) when an entry is optional. By default, the Required toggle 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
Advanced Styling
|
Setting |
Description |
|---|---|
|
Custom CSS Classes |
Enter a Custom CSS Cascading Style Sheets (CSS) is a style sheet language used for presenting how a HTML or XML document looks to end-users. 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 Checkboxes Component
Now, let's create an application that will collect the medical history of an applicant.
These instructions assume that you have an open modulesaved with a title.
Configure the Checkboxes Component
| 1. | In the Module Builder, drag and drop a  Checkboxes component onto your canvas. |
| 2. | In the Property ID A Property ID is the unique field ID used by Unqork to track and link components in your module. field, enter medicalHistory. |
| 3. | In the Label Text Label Text conveys what the input component is and what information it displays. Enter the purpose of the corresponding component or field. field, enter Do you have, or have you had any of the following? Please check all that apply.. |
| 4. | Under Formatting, set the Number of Columns to  (two columns). |
| 5. | Navigate to the component's Data settings. |
| 6. | To the right of the Values table, click Edit. The Values pane displays. |
| 7. | In the Values table, enter the following: |
| # | Option Label | Value to Store in Submission Data |
|---|---|---|
|
1 |
Angina |
angina |
|
2 |
Asthma |
asthma |
|
3 |
Breathing Problems |
breathingProblems |
|
4 |
Chest Pains |
chestPains |
|
5 |
Diabetes |
diabetes |
|
6 |
Hay Fever |
hayFever |
|
7 |
High Blood Pressure |
highBloodPressure |
|
8 |
Rheumatism |
rheumatism |
|
9 |
Shingles |
shingles |
|
10 |
Ulcers |
ulcers |
| 8. | In the upper-right corner of the Values pane, click Close. The new values display in the component's configuration panel. |
| 9. | Set Selection to Uncheck All Options to (ON). |
| 10. | Navigate to the component's Validation settings. |
| 11. | Set Required to (ON). |
| 12. | Click Save Component. |
| 13. | Save your module. |
Preview your module in Express View Express View is how your end-user views your application. Express View also lets you preview your applications to test your configuration and view the styling. This is also the view your end-users will see when interacting with your application. After configuring a module, click Preview in the Module Builder to interact with the module in Express View.. You'll see the following functionality:
Structure of a Checkboxes Component's Data
Using the example above, in Express View Express View is how your end-user views your application. Express View also lets you preview your applications to test your configuration and view the styling. This is also the view your end-users will see when interacting with your application. After configuring a module, click Preview in the Module Builder to interact with the module in Express View., execute the AngularJS AngularJS is a JavaScript framework added to an HTML page with a <script> tag. AngularJS extends HTML attributes and binds data to HTML using expressions. command in the DevTools Console The DevTools Console helps you securely store, build, test, and deploy your software.. The medicalHistory Checkboxes component stores selected options in an array when viewed in the developer console. If no options have been checked, then the array is empty.
Resources
Overview
With a Checkboxes component, you can create a question with more than one possible answer. Checkboxes let your end-user End-users, also known as Express Users, are the individuals accessing an application through Express View. In most cases, end-users are the customers using the product. choose more than one response from your provided options. As a comparison, the Radio Buttons component only allows one selection. With a Checkboxes component, your end-user can compare all available options, selecting all that apply.
Here are some examples of checkbox questions:
-
Do you have any of the following medical conditions? Please select all that apply.
-
What sports do you play on a regular basis? Please select all that apply.
-
Which of these account types are you interested in opening? Please select all that apply.
The Checkboxes component has built-in Select All and None of the Above options. This adds more versatility to your application and prevents conflicting responses.
You can also use a Checkboxes component to trigger a Text Field to display. Think of this as a write-in option for your end-user. For example, if none of the provided answers apply, they can select the Other box, which displays a separate text field. Then, they can enter their response.
A Checkboxes component can also trigger an existing component. For example, an end-user who wants to open an account can select Retirement from a list of options. When they select the Retirement box, a new drop-down displays. Here, they can select a more specific account type.
You'll find the Checkboxes 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
Default State Options
|
Contextual Help
Formatting
|
Data Panel
Data Source Types
There are two methods that you can use to populate a Checkboxes component: Values or a Data Reference Key.
Values
Values are the simplest way to populate a Checkboxes component. When you select Values, a Custom Checkbox Selections table displays. In this table, enter each checkbox option and its associated value.
|
Setting |
Description |
|---|---|
|
Option Label |
Each option needs an end-user End-users, also known as Express Users, are the individuals accessing an application through Express View. In most cases, end-users are the customers using the product.-facing label describing the choice that it represents. Enter your Option Labels using this column. After you create an option, another row displays for you to create the next option. |
|
Value to Store in Submission Data |
Each option needs an associated value to store in the submission data. Enter the values to store in submission data using this column. By default, the value is a camelCase A naming convention for computer programming. Use camelCase for Property IDs, for example: newUser, lastName, & rdoButton. version of the Option Label. |
Data Reference Key
With a Data Reference Key, you can use data from another component to populate your Checkboxes component. You'll most often do this with a Data Table component. Add your data to the Data Table and then reference it in your Checkboxes configuration window.
Think of this as a hybrid of using Values and Data Collection to populate your Checkboxes. You still use data stored in Unqork, but it's data from yourmodulerather than a Data Collection.
| Setting | Description |
|---|---|
|
Data Reference Key |
Enter the Property ID of the component whose data you're referencing. |
|
Value Property |
If a data set includes a column for values, enter the column's name here. If not specified, the application uses the data drawn using the Label Path setting below. |
|
Label Path |
This field refers to the option labels to retrieve. If you're retrieving data from a Data Table component, enter the column header in this field. |
Pre-Configured Checkbox Selections
|
Setting |
Description |
|---|---|
|
Selection to Trigger a Component |
When set to (ON), you can add an option that triggers another component when selected. This is useful if you want the end-user to give a custom response or to elaborate on a response. This new option displays at the bottom of the list. By default, the Selection to Trigger a Component toggle is set to (OFF). |
|
Option Label |
Each option needs an end-user End-users, also known as Express Users, are the individuals accessing an application through Express View. In most cases, end-users are the customers using the product.-facing label describing the choice that it represents. Enter your Option Labels using this column. After you create an option, another row displays for you to create the next option. By default, the Selection to Trigger a Component has the Option Label of Other. |
|
Value to Store in Submission Data |
Each option needs an associated value to store in the submission data. Enter the values to store in submission data using this column. By default, the value is a camelCase A naming convention for computer programming. Use camelCase for Property IDs, for example: newUser, lastName, & rdoButton. version of the Option Label. |
|
Component to Trigger When a User Selects This Option |
Here you have the choice of triggering a new Text Field or an existing component. The triggered Text Field or component displays below the associated checkbox option.
|
|
Property Name of Text Field |
If you select the Text Field option, you must give the new Text Field component a Property Name. |
|
Placeholder of Text Field |
If you select the Text Field, you can enter a placeholder text to assist the end-user. |
|
Property Name of Existing Component |
If you select the Choose Existing, you can enter the Property ID A Property ID is the unique field ID used by Unqork to track and link components in your module. of an existing component in your module to trigger. |
|
Selection to Uncheck All Options |
This setting adds a new checkbox (None of the Above) that, when selected, clears all other options. With None of the Above selected, the end-user can't make any other selections. To make another selection, they must clear None of the Above. By default, the Selection to Uncheck All Options toggle is set to (OFF). |
|
Option Label |
Each option needs an end-user End-users, also known as Express Users, are the individuals accessing an application through Express View. In most cases, end-users are the customers using the product.-facing label describing the choice that it represents. Enter your Option Labels using this column. After you create an option, another row displays for you to create the next option. By default, the Selection to Uncheck All Options has the Option Label of None of the Above. |
|
Value to Store in Submission Data |
Each option needs an associated value to store in the submission data. Enter the values to store in submission data using this column. By default, the value is a camelCase A naming convention for computer programming. Use camelCase for Property IDs, for example: newUser, lastName, & rdoButton. version of the Option Label. By default, the Selection to Uncheck All Options has a value of none. |
|
Selection to Select All Options |
This setting adds a new checkbox (Select All) that, when selected, selects all other options. This option automatically excludes the None of the Above option, if applicable. By default, the Selection to Select All Options toggle is set to (OFF). |
|
Option Label |
Each option needs an end-user End-users, also known as Express Users, are the individuals accessing an application through Express View. In most cases, end-users are the customers using the product.-facing label describing the choice that it represents. Enter your Option Labels using this column. After you create an option, another row displays for you to create the next option. By default, the Selection to Select All Options has the Option Label of Select All. |
Data Storage
|
Setting |
Description |
|---|---|
|
Promote Data to Top Level |
When set to When set to (OFF), values store as one string containing all selected items. By default, the Promote Data to Top Level toggle is set to (OFF). |
|
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:
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. To learn more about Store Data in Database in the context of API modules, see the panelResponse Panel section of the API Specification Snippet article in our In-Product Help. 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. |
(ON), the component's values store at the highest level of the submission data. Use this if you need responses to read True or False for each option instead of one list of all items selected.Actions Panel
Triggers
|
Setting |
Description |
|---|---|
|
Trigger |
To set up a trigger, enter the Property ID A Property ID is the unique field ID used by Unqork to track and link components in your module. 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. Set the toggle to (OFF) when an entry is optional. By default, the Required toggle 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 Classes |
Enter a Custom CSS Cascading Style Sheets (CSS) is a style sheet language used for presenting how a HTML or XML document looks to end-users. 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 Checkboxes Component
Now, let's create an application that will collect the medical history of an applicant. These instructions assume that you have an open modulesaved with a title.
Configure the Checkboxes Component
| 1. | In the Module Builder, drag and drop a Checkboxes component onto your canvas. |
| 2. | In the Property ID A Property ID is the unique field ID used by Unqork to track and link components in your module. field, enter medicalHistory. |
| 3. | In the Label Text Label Text conveys what the input component is and what information it displays. Enter the purpose of the corresponding component or field. field, enter Do you have, or have you had any of the following? Please check all that apply. |
| 4. | Set the Number of Columns as (two columns). |
| 5. | From the component navigation menu, select  Data. |
| 6. | In the table under the Values Data Source Type, enter the following: |
| Option Label | Value to Store in Submission Data |
|---|---|
|
Angina |
angina |
|
Asthma |
asthma |
|
Breathing Problems |
breathingProblems |
|
Chest Pains |
chestPains |
|
Diabetes |
diabetes |
|
Hay Fever |
hayFever |
|
High Blood Pressure |
highBloodPressure |
|
Rheumatism |
rheumatism |
|
Shingles |
shingles |
|
Ulcers |
ulcers |
| 7. | Set the Selection to Uncheck All Options toggle to (ON). |
| a. | The Option Label stays set to None of the above. You can leave this as set or change it as needed. |
| b. | The Value to Store in Submission Data stays set to None. You can leave this as set or change it as needed. |
| 8. | In the component navigation menu, select  Validation. |
| 9. | Set the Required toggle to (ON). |
| 10. | Click Save & Close. |
| 11. | Save your module. |
Preview your module in Express View Express View is how your end-user views your application. Express View also lets you preview your applications to test your configuration and view the styling. This is also the view your end-users will see when interacting with your application. After configuring a module, click Preview in the Module Builder to interact with the module in Express View.. You'll see the following functionality:
Structure of a Checkboxes Component's Data
A Checkboxes component stores its data as an array when viewed in the developer console.
Resources
