a!checkboxField( label, instructions, required, disabled, choiceLabels, choiceValues, value, validations, saveInto, validationGroup, requiredMessage, align, labelPosition, helpTooltip, choiceLayout, accessibilityText, showWhen, choiceStyle )
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.
| Name | Keyword | Types | Description |
|---|---|---|---|
|
Label |
|
Text |
Text to display as the field label. |
|
Instructions |
|
Text |
Supplemental text about this field. |
|
Required |
|
Boolean |
Determines if a value is required to submit the form. Default: false. |
|
Disabled |
|
Boolean |
Determines if the field should display as potentially editable but grayed out. Default: false. |
|
Choice Labels |
|
List of Text String |
Array of options for the user to select. |
|
Choice Values |
|
List of Variant |
Array of values associated with the available choices. |
|
Display Value |
|
List of Variant |
Values of choices to display as selected. |
|
Validations |
|
List of Text String |
Validation errors to display below the field when the value is not null. |
|
Save Input To |
|
List of Save |
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. |
|
Validation Group |
|
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 |
|
Text |
Custom message to display when the field's value is required and not provided. |
|
Alignment |
|
Text |
Determines alignment of choice labels. Appian recommends this setting only be used inside the Grid Layout component. Valid values: |
|
Label Position |
|
Text |
Determines where the label appears. Valid values:
|
|
Help Tooltip |
|
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 |
|
Choice Layout |
|
Text |
Determines the layout. Valid values: |
|
Accessibility Text |
|
Text |
Additional text to be announced by screen readers. Used only for accessibility; produces no visible change. |
|
Visibility |
|
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 |
|
Text |
Determines how the choices should be displayed on the interface. Valid values: |
"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 two lines will be truncated."STACKED" option for choiceLayout.Use the interactive editor below to test out your code:
The following patterns include usage of the Checkbox Component.
Configure a Boolean Checkbox (Choice Components): Configure a checkbox that saves a boolean (true/false) value, and validate that the user selects the checkbox before submitting a form.
Inline Survey (Radio Buttons, Checkboxes, Buttons): Use this pattern to create a clean and easy to navigate survey.
Make a Component Required Based on a User Selection (Validation): Make a paragraph component conditionally required based on the user selection.
