Group

Description

A Group component in form making is a UI element that allows you to logically group related form fields together.

It provides a visual and organizational structure to the form, making it easier for users to understand the relationships between different fields and navigate through the form.

Use Case

1. Organize related form fields

2. Enhance visual hierarchy

3. Improve form navigation

4. Provide contextual feedback

Examples may include:

1. Grouping Personal Information
2. Organizing Address Details
3. Separating Contact Information
4. Grouping Conditional Fields
5. Encapsulating Optional Fields
6. Organizing Payment Information
7. Grouping Order Details
8. Separating Review and Submit Actions
9. Grouping Error Messages
10. Organizing Multi-Step Forms

API

Methods

Name	Description	Parameters
this.addClassName	Add style class to a form item	(fields: String|String[], className: String)
this.removeClassName	Remove style class from a form item	(fields: String|String[], className: String)
this.getComponent	Returns a component whose id has been passed as a parameter	(component_ID: String) : Object
this.getValue	Get A Value From a component	(fieldName: String)
this.hide	Hides the field	(fields: String|String[])
this.show	Displays the field	(fields: String|String[])

Info

1. The show() and hide() methods can also be used to control the visibility of the group in response to user input.
2. Fields refers to a component ID or a list of component IDs. You can fetch the ID from the Component Attribute panel in the Page Builder.
3. Before using this.show(fields), make sure the component is hidden. This can be done using this.hide(fields) or by enabling the Hidden checkbox in the Component Attribute panel.

Steps to use the methods for the Page Builder components

1. Go to Form Attribute Action Panel Setting (Mounted | refresh | click 'Add action').
2. Write the method/code as shown in the Example below.
3. Click on Save.
4. On the main screen click on Save again.
5. Click on Preview to see the code in action.

Example

1. this.addClassName(fields, className)

   • Go to Form Attribute Style Sheets add the class

     .abc{ // abc is the class name
     background-color: red;
     }
     

   • Follow the steps mentioned above, under Steps to use the methods for the Page Builder components
   • this.addClassName('group_j9o3pb2i', 'abc')

2. this.removeClassName(fields, className)

   this.removeClassName('group_j9o3pb2i', 'abc')
   

3. this.getValue(fieldName)

   var groupname = this.getValue('group_j9o3pb2i');
   console.log('getValue', groupname);
   

4. this.hide(fields)

   var fields= ['group_j9o3pb2i']
   this.hide(fields)
   

5. this.show(fields)

   var fields= ['group_j9o3pb2i']
   this.show(fields)
   

6. this.getComponent('component_ID')

   var groupname = this.getComponent('group_j9o3pb2i');
   console.log('getComponent', groupname);
   

Info

Use the following syntax to add multiple classes to a component:

this.addClassName('componentID', 'class1', 'class2')

Config

Name	Description	Icon
ID	The group component's unique identifier
Name	[Optional] The display name of the grid
Width	[Optional] Width of the field
Label Width	Width of the label associated with an input field. It determines the horizontal space occupied by the label text
Label Wrap	If the label is longer than the allowed width the text will continue on another line
Hide Label	Hides the label on the form
Text Prompt	A description to aid the user when completing the field
Custom Class	An HTML class attribute which allows further customisation See Form Attribute > Style Sheets
Attribute Action	Enable Data Binding to connect the data to UI. Enable Hidden action to hide the field.

Validation

Form validation is the process of checking the data entered into a form to ensure that it's valid and complete.

This helps to prevent users from submitting forms with invalid data, which can cause problems for the application that's processing the form.

Form validation can be performed using a variety of methods, including:

Name	Description
Custom Validation Rules	(rule, value, callback) => {
	rule: Verification rule, you can view the verification configuration information through this parameter; rule.field can get the field identifier of the current verification

First time User?

If you are using the Page Builder components on the ConnexCS platform for the first time, we request you to use our guide on steps to use the Components.