Radio Button By Index Component

Function

a!radioButtonFieldByIndex( label, instructions, required, disabled, choiceLabels, 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 the index of the selected choice. To save a value instead of the index, use radio buttons.

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.

Display Value

value

Number (Integer)

Index of the 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 index 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, this field is only validated when a button in the same validation group is pressed. See the documentation for more information about how to use validation groups.

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 choiceLabels parameter

  • Choices display in the same order as defined in the choiceLabels parameter. The choiceLabels argument cannot be null.

Using the choiceLayout parameter

  • For long labels, use the "STACKED" option for choiceLayout.
  • 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 two lines will be truncated.
Open in Github Built: Tue, Sep 14, 2021 (11:54:22 AM)

On This Page

FEEDBACK