Radio Button Component

Function

a!radioButtonField( label, instructions, required, disabled, choiceLabels, choiceValues, value, validations, saveInto, validationGroup, requiredMessage, labelPosition, choiceLayout, helpTooltip, accessibilityText, showWhen, choiceStyle, spacing, data, sort, marginAbove, marginBelow )

Displays a limited set of choices from which the user must select one item and saves a value based on the selected choice. To save the index instead of a value, use radio buttons by index.

If the choice is not exclusive, then consider using checkboxes or a multiple dropdown component.

If there are many choices, make the component as large as necessary to display all the options. If a more compact presentation is desirable, consider using a dropdown component.

Parameters

Usage considerations

Using the choiceLayout parameter

• The "COMPACT" option for choiceLayout should only be used for radio buttons with short choice labels, such as "Yes", "No", or "Maybe". When using the "COMPACT" option, labels with text longer than 2 lines will be truncated.
• For long labels, use the "STACKED" option for choiceLayout.

Using the choiceLabels and choiceValue parameters

When configuring the Choice Labels and Choice Values parameters, keep the following in mind:

• The Choice Labels cannot be null.
• The Choice Values cannot contain nulls or duplicate values.
• The Choice Labels list and Choice Values list must be the same length.

When you select Record Type as the data source, the Choice Labels and Choice Values are automatically populated with record field references. By default, the labels will be the first text field from the record type, and the values will be the primary key field.

You can format and display multiple record fields in the Choice Labels parameter using fv!data and a record field reference. For example, if you want to display a list of US cities with their states in parentheses, you could use the following expression:

1
choiceLabels: fv!data[recordType!Location.fields.city] & " (" & fv!data[recordType!Location.fields.state] & ")"

This would display choice labels as:

1
2
3
4
5
New York City (New York)
Los Angeles (California)
Chicago (Illinois)
Houston (Texas)
Phoenix (Arizona)

Sort choices

The way you sort the choices depends on the source of the component. If no sort is applied, the labels will appear in the order they're provided.

When you select Record Type as the data source:

• The choice order is determined by the Sort parameter.

• You can automatically sort by the values configured in the Choice Labels or Choice Values parameters by using "choiceLabels" or "choiceValues" in the a!sortInfo() function.

  For example, a!sortInfo(field: “choiceLabels”, ascending: true) would automatically sort the choices by the values in the Choice Labels parameter.

When you select Other as the data source:

• The choices display in the order defined in the Choice Labels.

Row limit for records-powered components

Interface components that use a record type as the data source are known as records-powered components.

Records-powered components can display a maximum of 5,000 rows. As a best practice, you should not display all 5,000 rows in a component since it may impact performance.

Examples

Record type object references are specific to each environment. If you copy and paste the example with record field references into your interface, it will not evaluate. Use that example as a reference only.

Radio button with choices from a record type

In this example, the component's choices are retrieved from a reference record type that contains the industries your customer's represent. choiceLabels uses the name field and the corresponding choiceValues are set using the record type's primary key field, id.

1
2
3
4
5
6
7
8
9
10
11
12
13
a!radioButtonField(
  data: recordType!AT Industry,
  choiceLabels: recordType!AT Industry.fields.name,
  choiceValues: recordType!AT Industry.fields.id,
  label: "Industry",
  value: ri!record[recordType!AT Customer.fields.districtId],
  saveInto: ri!record[recordType!AT Customer.fields.districtId],
  sort: 
    a!sortInfo(
      field: "choiceLabels",
      ascending: true
    )
)

Radio Button with first choice selected by default

Use the interactive editor below to test out your code:

Radio Buttons with compact layout and cards style

Use the interactive editor below to test out your code:

Feature compatibility

Old versions

There are older versions of this interface component. You can identify older versions by looking at the name to see if there is a version suffix. If you are using an old version, be sure to refer to the corresponding documentation from the list below.

To learn more about how Appian handles this kind of versioning, see the Function and Component Versions page.

Related Patterns

The following patterns include usage of the Radio Button Component.

• Inline Survey (Radio Buttons, Checkboxes, Buttons): Use this pattern to create a clean and easy to navigate survey.

Feedback