Radio Buttons Component

 

Overview

The Radio Buttons component creates a list of mutually exclusive options for end-users. 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 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 Builder.

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.

Field Text

A static image displaying the Radio Buttons component's Display settings.

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

Default State Options

Setting

Description

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

Horizontal Layout

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

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

Show as Button Group

When set to  (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 (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.

Add a Radio Buttons component to collect your end-user's age. You'll present five age ranges, allowing for a single selection by the end-user.

1. In the Module Builder, drag and drop a Radio Buttons component onto your canvas.
2. In the Property ID field, enter ageRange.
3. In the Label Text field, enter How old are you?.
4. Navigate to the component's Data settings.
5. Next to the Values table, click Edit. The Values panel displays.
6. Underneath the Values table, click New five times.
7. In the Option Label and Option Value fields, enter the following:
#

Option Label

Option Value

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

8. Click Save Component.
9. Save your module.

Once implemented, your Radio Buttons component looks like the following in Express View:

The Radio Buttons component's data stores in a key/value format. In the above example, the ageRange Radio Buttons component stores the 16-20YearsOld value.

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

Resources