Grid

Description

A Grid component in a form is a UI element that allows you to display and organize data in a tabular format within a form.

It typically consists of a set of rows and columns, each containing a specific data element or input field.

Grid components are commonly used to present structured data in a clear and organized manner, making it easier for users to understand and interact with the form.

Use Case

1. Data Organization
2. Visual Representation
3. User Input Management
4. Responsive Layout

Examples may include:

1. Data Validation
2. Product Order Forms
3. Employee Management Forms
4. Inventory Management Forms
5. Data Collection 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.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 grid 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('grid_th1wozzk', 'abc')

2. this.removeClassName(fields, className)

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

3. this.hide(fields)

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

4. this.show(fields)

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

5. this.getComponent('component_ID')

   var gridname = this.getComponent('grid_th1wozzk');
   console.log('getComponent', gridname);
   

Info

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

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

Config

Name	Description	Icon
ID	The grid component's unique identifier
Grid Spacing	[Optional] Space between various components inside the grid
Flex Layout	[Optional] Allows flexibility to arrange the various components inside the grid
Horizontal Arrangement	Select from various options Start, End, Center, Space Around, Space Between for horizontal arrangement of the components inside the grid
Vertical Arrangement	Select from various options Top, Middle, Bottom for vertical arrangement of the components inside the grid
Custom Class	An HTML class attribute which allows further customisation See Form Attribute > Style Sheets
Attribute Action	Enable Hidden action to hide the field

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.