Checkbox By Index Component

Checkbox By index component

Function: a!checkboxFieldByIndex()

Displays a limited set of choices from which the user may select none, one, or many items and saves the indices of the selected choices. To save a value instead of an index, use checkboxes. This component is not available from the interface component picker in the design view.

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

List of Number (Integer)

Indices of choices 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 indexes when the user changes the selections. 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.

Alignment

align

Text

Determines alignment of choice labels. Appian recommends this setting only be used inside the Grid Layout component. Valid values: "LEFT", "CENTER", "RIGHT".

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.

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

Choice Layout

choiceLayout

Text

Determines the layout. Valid values include "STACKED" (default) to display the choices one on top of another and "COMPACT" to display the choices side-by-side.

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

Saving values

  • If a single item is selected, the system saves a single-item array.
  • If no selection is made, the system saves a null value into the component's saveInto parameter. If a single item is selected, the system saves a single-item array.

Using the choiceLabels and choiceLayout parameters

  • Choices display in the same order as defined in the choiceLabels parameter. The choiceLabels argument cannot be null.
  • The "COMPACT" option for choiceLayout should only be used for checkboxes 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.
Open in Github Built: Thu, Feb 23, 2023 (02:59:22 PM)

On This Page

FEEDBACK