Checkbox Component

Checkboxes

Function: a!checkBoxField()

Displays a limited set of choices from which the user may select none, one, or many items and saves the values of the selected choices. To save the index of the choice instead of a value, use checkboxes by index.

If the choice is exclusive, then consider using radio buttons or a dropdown.

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

See Also: Interface Recipe: Configure a Boolean Checkbox

Parameters

Name Keyword Type Description
Label label Text Optional text to display as the field label.
Label Position labelPosition Text Optional text to determine where the label appears. Valid values include
  • "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.
Instructions instructions Text Optional text displayed below the series of checkboxes.
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 Labels choiceLabels Text Array List of options for the user to choose from.
Choice Values choiceValues Any Type List of values associated with the available choices.
Selected Values value Any Type Array of values corresponding to the selected choices.
Save Selection To saveInto Save Array One or more variables that are updated with the choice values when the user changes the selections. Use a!save() to save a modified or alternative value to a variable.
Required required Boolean Determines if a value is required to submit the form. Default is false.
Required Message requiredMessage Text Custom message to be displayed when the field's value is required and not provided.
Disabled disabled Boolean Determines if the user is prevented from changing the value. Default is false.
Choice Layout choiceLayout Text Optional text to determine the layout of the list of options. Valid values include "STACKED" (default) to display the choices one on top of another and "COMPACT" to display the choices side-by-side.
Validations validations Text Array Validation errors to be displayed below the field when the value is not null.
Validation Group validationGroup Text When present, this field is only validated when a button in the same validation group is clicked.
Alignment align Text Alignment of the choice labels (except on mobile devices). Valid values are "LEFT", "CENTER", and "RIGHT". Appian recommends setting the alignment when used in an editable grid only.
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.

Notes

  • Choices display in the same order as defined in the Choice Labels parameter. The Choice Labels argument cannot be null.
  • 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 Save Selection To field. If a single item is selected, the system saves a single-item array.
  • Choice Labels and Choice Values must be the same length.
  • Choice Values cannot contain nulls or duplicate values.

Examples

Copy and paste an example into the INTERFACE DEFINITION in EXPRESSION MODE to see it displayed.

Checkbox with First and Third Values Checked

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
=a!checkboxField(
  label: "Language",
  instructions: "In which languages are you proficient?",
  choiceLabels: {
    "English",
    "Spanish",
    "French",
    "German"
  },
  choiceValues: {
    "en_US",
    "es_ES",
    "fr_FR",
    "de_DE"
  },
  value: {"en_US", "fr_FR"}
)

Displays the following:

Editable Checkbox with No Default Values Checked

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
=load(
  local!language: null,
  a!checkboxField(
    label: "Language",
    instructions: "In which languages are you proficient?",
    choiceLabels: {
      "English",
      "Spanish",
      "French",
      "German"
    },
    choiceValues: {
      "en_US",
      "es_ES",
      "fr_FR",
      "de_DE"
    },
    value: local!language,
    saveInto: local!language
  )
)

Displays the following:

FEEDBACK