Checkbox Group

A checkbox group in an Adaptive Form is a set of related checkboxes that allow users to select one or more options from a list. Each checkbox is represented by a Data Value (value used to process items of a checkbox group) and Display value (label for each checkbox item that describes its purpose)

Example

checkbox group example

Properties Dialog

checkbox group property dialog

In this example, Options element is used to group the checkboxes together. The Display text element is used to provide a label for an item and Data Value is used to specify the value that is sent to the server when the form is submitted.

Each checkbox option/item has a unique Data value and Display Text attribute. If a user selects the “Son” and “Daughter” checkboxes, the corresponding Data Value is sent to the server when the form is submitted. This data can then be processed by a server-side script to determine which options were selected by the user, and can be used to perform various actions, such as updating other fields in the form or submitting the form data to a server-side script for further processing.

Additionally, The checkbox group can be configured to have different processing values for each option, and this can be set by using Adaptive Forms Rule Editor.

Usage

There are several reasons why it is beneficial to include a checkbox group in an Adaptive Form, including:

  • Multiple selections: A checkbox group allows users to select multiple options from a list, which can be useful in situations where multiple selections are allowed or required.

  • User experience: Checkbox group can be used to make the form more user-friendly by providing a clear and intuitive way for users to select multiple options.

  • Data analysis: Checkbox group can be used to collect data from various sources and analyze it, or use it as input for further processing.

  • Surveys: Checkbox group can be used in surveys to select multiple options for a question.

  • User preferences: Checkbox group can be used to collect user preferences for different options.

  • Data Value: Checkbox group can also be used to process items of a checkbox group.

Version and Compatibility

The Adaptive Forms Accordion Core Component was released in Feb 2023 as part of the Core Components 2.0.4 for Cloud Service and Core Components 1.1.12 for AEM 6.5.16.0 Forms or later. Here’s a table showing all supported versions, AEM compatibility, and links to corresponding documentation:

Component Version
AEM as a Cloud Service
AEM 6.5.16.0 Forms or later
v1
Compatible with
release 2.0.4 and later
Compatible with
release 1.1.12 and later but less than 2.0.0.

For information on Core Component versions and releases, refer to the Core Components Versions document.

Technical Details

Get the latest information on the Adaptive Forms Checkbox Group Core Component in the technical documentation on GitHub. For more on developing Core Components, check out the Core Components developer documentation.

Configure Dialog

You can easily customize your checkbox experience for visitors with the Configure Dialog. You can also define checkbox options with ease for a seamless user experience.

Basic Tab

Basic tab

  • Name - The name uniquely identifies the component in the rule editor.Special characters and spaces are not allowed in the name strings.

  • Title - With its Title, you can easily identify a component in a form and by default, the title appears on top of the component. If you do not add a title, the name of the component is displayed instead of the title text.

  • Hide Title - Select the option to hide the component’s Title.

  • Options - You can add data values and display text pairs using the Add button. Once a new option is added, the following actions can be performed:

    • Data Value - This option allows to enter the content to submit when an option is selected.
    • Display Text - This option allows to enter the content to display in an Adaptive Form.
    • Delete - Tap or click to delete the option of a checkbox .
    • Rearrange - Tap or click and drag to rearrange the order of the panels.
  • Bind Reference - A bind reference is a reference to a data element that is stored in an external data source and used in a form. The bind reference allows you to dynamically bind data to form fields, so that the form can display the most up-to-date data from the data source. For example, a bind reference can be used to display a customer’s name and address in a form, based on the customer’s ID entered into the form. The bind reference can also be used to update the data source with data entered into the form. In this way, AEM Forms enables you to create forms that interact with external data sources, providing a seamless user experience for collecting and managing data.

  • Mark as Unbound Form Element: Select the option to configure a form field not linked to any schema. This option allows you to save data without updating the data source. It also enables you to handle data in a custom way, separate from standard database integration.

  • Data type of submitted value - This option specifies the data type of the value sent when any option is selected. If the data type of submitted value is set to Number and you add string data to Data Value ​​on the Options tab, the screen displays a Value type mismatch error message.

  • Display options - This option is used to set the visual alignment of checkboxes in an Adaptive Form. The two options supported are:

    • Horizontal - When this option is selected, checkboxes are displayed left to right in an Adaptive Form.
    • Vertical - When this option is selected, checkboxes are displayed top to bottom in an Adaptive Form.
  • Default options - This option allows you to add pre-selected default values when the form loads. Use the delete icon to remove the added options. If the data type of submitted value is set to Number and you add string data to Default options, the screen displays a Value type mismatch error message.

  • Hide Component - Select the option to hide the component from the form. The component remains accessible for other purposes, such as using it for calculations in the Rule Editor. This is useful when you need to store information that doesn’t need to be seen or directly changed by the user.

  • Disable Component - Select the option to disable the component. The disabled component is not active or editable by the end user. The user can see the value of the field but cannot modify it. The component remains accessible for other purposes, such as using it for calculations in the Rule Editor.

  • Read-only - Select the option to make the component non-editable. The user can see the value of the field but cannot modify it. The component remains accessible for other purposes, such as using it for calculations in the Rule Editor.

Validation Tab

Validation tab

  • Required - Select this option, if you want to display the component in an Adaptive Form. After selecting the option, you must make a selection before proceeding with a form submission. You cannot select the Hide Component or Disable Component in the Basic tab when this option is selected.

  • Error Message - This option allows you to enter a message that is displayed if the Required checkbox is checked and the form field is left blank.

  • Script Validation Message - This option allows you to enter a message to be displayed if the script validation fails.

Help Content Tab

Help Content tab

  • Short description - A short description is a brief text explanation that provides additional information or clarification about the purpose of a specific form field. It helps the user understand what type of data should be entered into the field and can provide guidelines or examples to help ensure that the information entered is valid and meets the desired criteria. By default, short descriptions remain hidden. Enable the Always show short description option to display it below the component.

  • Always show short description - Enable the option to display the Short description below the component.

  • Help text - Help text refers to additional information or guidance that is provided to the user to assist them in filling out a form field correctly. It appears when the user clicks the help icon (i) placed next to the component. Help text provides more detailed information than a form field’s label or placeholder text, and is designed to help the user understand the requirements or constraints of the field. It can also offer suggestions or examples to make filling out the form easier and more accurate.

Accessibility Tab

Accessibility tab

Text for screen readers - Text for screen readers refers to additional text that is specifically intended to be read by assistive technologies, such as screen readers, used by visually impaired individuals. This text provides an audio description of the form field’s purpose, and can include information about the field’s title, description, name, and any relevant messages (Custom text). The screen reader text helps ensure that the form is accessible to all users, including those with visual impairments, and provides them with a complete understanding of the form field and its requirements.

Design Dialog

Design Dialog is used to define and manage CSS styles for the Check-box Group component.

Styles Tab

The Adaptive Forms Checkbox Group Core Component supports the AEM Style System.

Design Dialog

  • Default CSS Classes: You can provide a default CSS class for the Adaptive Forms Checkbox Group Core Component.

  • Allowed Styles: You can define styles by providing a name and the CSS class that represents the style. For example, you can create a style named “bold text” and provide the CSS class “font-weight: bold”. You can use or apply these styles to an Adaptive Form in Adaptive Forms editor. To apply a style, in Adaptive Forms editor, select the component you want to apply the style to, navigate to the properties dialog, and select the desired style from the Styles drop-down list. If you need to update or modify the styles, simply return to the Design Dialog, update the styles in the styles tab, and save the changes.

Custom Properties

Custom Properties Dialog

Custom properties allows you to associate custom attributes (key-value pairs) to an Adaptive Form core component using the form template. The custom properties are reflected in the properties section of the headless rendition of the component. It allows creating dynamic form behavior that adapts based on the custom attributes values. For example, developers can design various renditions of a Headless Forms component for mobile, desktop, or web platforms, significantly enhancing the user experience across a wide array of devices.

  • Group Name: You can provide a name to identify the custom property group. You can add, delete, or rearrange multiple custom property groups. After adding the custom property group, you can see the following options:

    • Key-Value Pairs: You can add multiple custom property names and custom property values by clicking the Add button for each custom property group.

    • Delete: Tap or click to delete the custom property name and custom property value.

    • Rearrange: Tap or click and drag to rearrange the order of the custom property name and custom property value.

)

See Also

d2be9096-a81e-404b-9952-d8925af7219c