Radio Buttons Component

Estimated Reading Time:  4 minutes

Overview

The Radio Buttons component creates a list of mutually exclusive options for end-users End-Users are the individuals accessing an application through Express View. In most cases, end-users are the customers using the product.. Use the Radio Buttons component when you have a list with five or fewer options, and the end-user can only select one of the options.

Here are some real-world examples of when to use a Radio Buttons component:

  • Ask a Yes or No question.

  • Select an age or salary range.

  • Create a multiple-choice quiz.

  • Choose from a product selection.

The Radio Buttons component is located in the Primary Fields group to the left of the Module Editor.

What You'll Learn

After completing this article, you’ll know when to use a Radio Buttons component, how to configure its settings, and how to use it in an Unqork application.

About the Configuration Window

General

A static image displaying the Radio Buttons component's configuration window.

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.

Notes Notes icon

Select this tab to display the component's Notes area. You can use notes to keep your teammates informed.

The Notes editor offers a semi-WYSIWYG (What You See is What You Get) content editor. Built to look like a word processor, this editor lets you create, edit, and format your notes. Notes save when saving the component.

Display Icon Display

Select this tab to manage your component's display settings.

Data Icon Data

Select this tab to manage your component's data settings.

Actions Icon Actions

Select this tab to manage your component's actions settings.

Validation Icon Validation

Select this tab to manage your component's validation settings.

Advanced Icon Advanced

Select this tab to manage your component's advanced settings.

Permissions Icon Permissions

Select this tab to see the RBAC RBAC (Role-Based Access Control) is a method to control system access for authorized users. The role in RBAC refers to the levels of access employees have to a network. (role-based access control) settings of the component.

Field Tag Icon Field Tags

Assign components one-word labels to help organize, identify, and group the components in your application.

Consider an example from the API Specification Snippet: Field Tags are applied to Hidden components in the panelRequest and panelResponse Panels. The Field Tags identify the data type of parameters included in the 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. request and response. The API Docs Dashboard tool populates with information about each parameter’s data type, identified by the Field Tag.

Field Tags act as a type of Property ID A Property ID is the unique field ID used by Unqork to track and link components in your module. group and let you group components for configuration purposes. Field Tags let you target two or more components using a simple logic component.

For example, add the Field Tag tagForDecision to multiple components in your module. Open the Inputs table of a Decisions component and reference the tagForDecision Field Tag as the input of the Decisions component. The output of the Decisions component then affects all components with the tagForDecision Field Tag.

Save your Field Tags by pressing Enter (Return) or adding a comma after each entry.

Shortcuts Icon Shortcuts

Select this tab to open the list of supported keyboard shortcuts you can use in the component settings modal. Keyboard shortcuts include:

  • Cmd + S (Mac) / Ctrl + S (PC): Save and close the component settings modal.

  • Cmd + G (Mac) / Ctrl + G (PC): Opens a search window to find specific fields and settings in the component settings modal.

  • Tab: Tab to the next field or setting in the component settings modal. This keyboard shortcut tabs left to right and top to bottom.

  • Shift + Tab: Tab to the previous field or setting in the component settings modal. The keyboard shortcut tabs from right to left and bottom to top.

  • Enter (Return): When tabbing to a Tooltip Icon (tooltip), press Enter (Return) to display the field or setting tooltip. Press Enter (Return) again to hide the tooltip.

Additional keyboard shortcuts:

  • Drop-down menus: When you Tab to a settings drop-down, use the keyboard's Up-Arrow Icon (up)/ Down-Arrow icon (down) arrows to make a selection. Then, press Enter (Return) to confirm the selection.

Documentation IconDocumentation

Select this tab to access the component documentation in Unqork's In-Product Help.

Cancel

Click this button to undo any unsaved configuration changes and return to the canvas.

Save & Close

Click this button to save all settings as configured and return to the canvas.

Display Panel

A static image dispaying the Radio Buttons component's Display settings.
(click to expand image)

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.

Default State Options

Setting

Description

Read Only View

When set to Toggle On Icon (ON), the component is display-only. If another component pushes content to the field, the end-user sees that content. Otherwise, end-users see the word None.

By default, the Read Only View toggle is set to Toggle Off icon (OFF).

Disable User Input

When set to Toggle On Icon (ON), end-users can’t 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 Toggle Off icon (OFF).

Hide Field

Shows or hides the component from view. Setting the Hide Field toggle to Toggle On Icon (ON) hides the component in Express View. Setting the toggle to Toggle Off icon (OFF) shows the component. The component is always visible in the Module Editor.

By default, the Hide Field toggle is set to Toggle Off icon (OFF).

Contextual Help

Setting

Description

Tooltip

A short hint that displays when an end-user positions their cursor over the Questionmark Icon (Tooltip) icon. Tooltips can display across more than one line.

Formatting

Setting

Description

Horizontal Layout

By default, the component's options display vertically, one below the other. When set to Toggle On Icon (ON), the component's options display horizontally, side-by-side.

By default, Horizontal Layout is set to Toggle Off icon (OFF).

Show as Button Group

When set to Toggle On Icon (ON), Radio Buttons options display as buttons instead of a list of dots. To use this setting, you must have an existing button group style within your environment.

By default, the Show as Button Group toggle is set to Toggle Off icon (OFF).

Data Panel

A static image dispaying the Radio Buttons component's Data settings.
(click to expand image)

Data Source Type

There are two methods that you can use to populate a Radio Buttons component: Values or a Data Reference Key.

Values

Values are the simplest way to populate a Radio Buttons component. In this table, enter each Radio Button option and its associated value.

Setting

Description

Option Label

Each option needs an end-user End-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 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 Radio Buttons. You'll most often achieve this funtion with a Data Table component. Add your data to the Data Table and then reference it in your Radio Buttons component's configuration window.

Think of this as a hybrid of using Values and Data Collection to populate your Radio Buttons. 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 that you're pulling data from.

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 pull. If you're pulling from a Data Table component, enter the column header in this field.

Data Storage

Setting

Description

Store Data in Database

The Store Data in Database setting affects how data persists through your application. When set to Toggle On Icon (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.

NOTE  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 Toggle Off icon (OFF) when you don’t want to store the values from this field in the database.

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

TIP  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 Toggle On Icon (ON) in Module Settings, only values from fields with Store Data in Database enabled are tracked.

Actions Panel

A static image dispaying the Radio Buttons component's Actions settings.
(click to expand image)

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

A static image dispaying the Radio Buttons component's Validation settings.
(click to expand image)

User Input

Setting

Description

Required

When set to Toggle On Icon (ON), the end user must enter a value in the component's visible fields. Set the toggle to Toggle Off icon (OFF) when an entry is optional.

By default, the Required toggle is set to Toggle Off icon (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

A static image dispaying the Radio Buttons component's Advanced settings.
(click to expand image)

Additional Validation Options

Setting

Description

Require Unique Submission Data

When set to Toggle On Icon (ON), the end-user cannot select an option that displays in an existing database submission.

By default, the Require Unique Submission Data toggle is set to Toggle Off icon (OFF).

Additional Styling

Setting

Description

Custom CSS Class

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. Use custom CSS to maintain a consistent look and feel if the field or element is part of a template or more than one module.

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

Adding a Radio Buttons Component

Add a Radio Buttons component to collect your end-user End-Users are the individuals accessing an application through Express View. In most cases, end-users are the customers using the product.'s age. You'll present five age ranges, allowing for a single selection by the end-user.

1. In the Module Editor, drag and drop a Radio Buttons icon Radio Buttons 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 ageRange.
3. In the Label Text field, enter How old are you?.
4. In the component's configuration window, click the Data Icon Data tab.
5. Set your Option Label and Value to Store in Submission Data as shown below:
 

Option Label

Value to Store in Submission Data

1

0-15 years old

0-15YearsOld

2

16-20 years old

16-20YearsOld

3

21-30 years old

21-30YearsOld

4

31-45 years old

31-45YearsOld

5

45+ years old

45+YearsOld

A static image displaying the Radio Buttons component's data settings. The Values table is filled out with age ranges and their corresponding values.

6. Click Save & Close.
7. Save your module.

Once implemented, your Radio Buttons look like the following in Express View Express View is how your end-user views you application. Express View also lets you preview your applications to test your configuration and view the styling. After configuring a module, click Preview in the Module Editor to interact with the module in Express View:

Structure of a Radio Buttons Component's Data

The data structure of a Radio Button's selection is a key value pair. The key is the Property ID name of the component, and the value is stored as a string.

A static image displaying the Radio Buttons component's data structure as seen in Developer Console view.

Resources