Adaptive Form CheckBox Group component written in HTL.
- Provides the following type of input:
- checkbox
- Custom constraint messages for the above types
- Styles
The Form CheckBox Group component uses the com.adobe.cq.forms.core.components.models.form.CheckBoxGroup
Sling Model for its Use-object.
The following properties are written to JCR for this Form CheckBox Group component and are expected to be available as Resource
properties:
./jcr:title
- defines the label to use for this field./hideTitle
- if set totrue
, the label of this field will be hidden./name
- defines the name of the field, which will be submitted with the form data./default
- defines the default value of the field./description
- defines a help message that can be rendered in the field as a hint for the user./required
- if set totrue
, this field will be marked as required, not allowing the form to be submitted until the field has a value./requiredMessage
- defines the message displayed as tooltip when submitting the form if the value is left empty./readOnly
- if set totrue
, the filed will be read only./type
- defines the data type of the value./enum
- defines the set of possible values for this field./enumNames
- defines the user-friendly text to display for the possible options of the field.
The component provides a core.forms.components.checkboxgroup.v1.runtime
client library category that contains the Javascript runtime for the component.
It should be added to a relevant site client library using the embed
property.
It also provides a core.forms.components.checkboxgroup.v1.editor
editor client library category that includes
JavaScript handling for dialog interaction. It is already included by its edit dialog.
BLOCK cmp-adaptiveform-checkboxgroup
ELEMENT cmp-adaptiveform-checkboxgroup__label
ELEMENT cmp-adaptiveform-checkboxgroup__label-container
ELEMENT cmp-adaptiveform-checkboxgroup__widget
ELEMENT cmp-adaptiveform-checkbox__widget
ELEMENT cmp-adaptiveform-checkbox__label
ELEMENT cmp-adaptiveform-checkboxgroup__questionmark
ELEMENT cmp-adaptiveform-checkboxgroup__shortdescription
ELEMENT cmp-adaptiveform-checkboxgroup__longdescription
ELEMENT cmp-adaptiveform-checkboxgroup__errormessage
By placing the class names cmp-adaptiveform-checkboxgroup__label
and cmp-adaptiveform-checkboxgroup__questionmark
within the cmp-adaptiveform-checkboxgroup__label-container
class, you create a logical grouping of the label and question mark elements. This approach simplifies the process of maintaining a consistent styling for both elements.
The following attributes must be added for the initialization of the checkbox-group component in the form view:
data-cmp-is="adaptiveFormCheckBoxGroup"
data-cmp-adaptiveformcontainer-path="${formstructparser.formContainerPath}"
The following are optional attributes that can be added to the component in the form view:
data-cmp-valid
having a boolean value to indicate whether the field is currently valid or notdata-cmp-required
having a boolean value to indicate whether the field is currently required or notdata-cmp-readonly
having a boolean value to indicate whether the field is currently readonly or notdata-cmp-active
having a boolean value to indicate whether the field is currently active or notdata-cmp-visible
having a boolean value to indicate whether the field is currently visible or notdata-cmp-enabled
having a boolean value to indicate whether the field is currently enabled or not
We support replace feature that allows replacing Reset Button component to any of the below components:
- Drop Down
- Radio Button
- Vendor: Adobe
- Version: v1
- Compatibility: Cloud
- Status: production-ready