Radio Button Component (a!radioButtonField)

Selection

Radio Button Component

Function

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

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

Name	Keyword	Types	Description
Label	`label`	Text	Text to display as the field label.
Instructions	`instructions`	Text	Supplemental text about this field.
Required	`required`	Boolean	Determines if a value is required to submit the form. Default: false.
Disabled	`disabled`	Boolean	Determines if the field should display as potentially editable but grayed out. Default: false.
Choice Labels	`choiceLabels`	List of Text String	Array of options for the user to select.
Choice Values	`choiceValues`	List of Variant	Array of values associated with the available choices.
Display Value	`value`	Any Type	Value of choice to display as selected.
Validations	`validations`	List of Text String	Validation errors to display below the field when the value is not null.
Save Input To	`saveInto`	List of Save	One or more variables that are updated with the choice value when the user changes the selection. Use a!save() to save a modified or alternative value to a variable.
Validation Group	`validationGroup`	Text	When present, the requiredness of the field is only evaluated when a button in the same validation group is pressed. The value for this parameter cannot contain spaces. For example, `“validation group”` is not a valid value. You need to add an underscore between words: `“validation_group”`. See the following recipes for more information: Configure Buttons with Conditional Requiredness Validation Groups for Buttons with Multiple Validation Rules'
Required Message	`requiredMessage`	Text	Custom message to display when the field's value is required and not provided.
Label Position	`labelPosition`	Text	Determines where the label appears. Valid values: `"ABOVE"` (default) Displays the label above the component. `"ADJACENT"` Displays the label to the left of the component. `"COLLAPSED"` Hides the label. The label will still be read by screen readers; see accessibility considerations for more information. `"JUSTIFIED"` Aligns the label alongside the component starting at the edge of the page.
Choice Layout	`choiceLayout`	Text	Determines the layout. Valid values: `"STACKED"` (default), `"COMPACT"`.
Help Tooltip	`helpTooltip`	Text	Displays a help icon with the specified text as a tooltip. The tooltip displays a maximum of 500 characters. The help icon does not show when the label position is `"COLLAPSED"`.
Accessibility Text	`accessibilityText`	Text	Additional text to be announced by screen readers. Used only for accessibility; produces no visible change.
Visibility	`showWhen`	Boolean	Determines whether the component is displayed on the interface. When set to false, the component is hidden and is not evaluated. Default: true.
Choice Style	`choiceStyle`	Text	Determines how the choices should be displayed on the interface. Valid values: `"STANDARD"` (default), `"CARDS"`.

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 choiceLayout and choiceValue parameters

Choices display in the same order as defined in the choiceLabels parameter.
The choiceLabels argument cannot be null.
choiceLabels and choiceValues must be the same length.
choiceValues cannot contain nulls or duplicate values.

Examples

Use the interactive editor below to test out your code:

Radio Button with first choice selected by default

Radio Buttons with compact layout and cards style

Feature compatibility

The table below lists this component's compatibility with various features in Appian.

Feature	Compatibility	Note
Portals	Compatible
Offline Mobile	Compatible
Sync-Time Custom Record Fields	Incompatible
Real-Time Custom Record Fields	Incompatible
Process Reports	Incompatible	You cannot use this function to configure a process report.
Process Events	Incompatible	You cannot use this function to configure a process event node, such as a start event or timer event.

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.