Skip to content

Custom Grid

The Custom Grid is a component that allows you to add and customize grid item components as grid items.
Actions from added components can also be executed.
This component was added in v3.4.0.

NoList Item Component
1Text Field
2Text Area
3Number Field
4Big Number
5Search Field
6Password
7Select
8Combobox
9Date Picker
10Date Time Picker
11Time Picker
12Radio Button
13Radio Button Group
14Checkbox
15Checkbox Group
16Switch
17Rating
18Slider
19Button
20Typography
21Rich Text
22Image
23External Resource
24Link
25Box
26Divider

Properties

NoItemInput ValueDefault ValueAction PropertyTypeAction Default ValueDescription
1IDStringAuto-setidstringAuto-setThe [id] property cannot be set by actions.
2WidthString672
390 [Mobile]
widthstring672
390 [Mobile]
Component width
3HeightString672
570 [Mobile]
heightstring672
570 [Mobile]
Component height
4XStringxstringX coordinate position
5YStringystringY coordinate position
6LockBooleanOFFlockbooleanfalseWhen ON, the component stays fixed even when the screen is scrolled.
When OFF, the component moves along with the screen scroll.
Added in v4.1.0.
7TopNumber10paddingTopnumber10Top padding between custom grid and grid items
Negative values are treated as default values
8RightNumber10paddingRightnumber10Right padding between custom grid and grid items
Negative values are treated as default values
9BottomNumber10paddingBottomnumber10Bottom padding between custom grid and grid items
Negative values are treated as default values
10LeftNumber10paddingLeftnumber10Left padding between custom grid and grid items
Negative values are treated as default values
11Grid Item WidthNumber320
365 [Mobile]
gridItemWidthnumber320
365 [Mobile]
Grid item width
Empty values are treated as default values
12Grid Item HeightNumber320
230 [Mobile]
gridItemHeightnumber320
230 [Mobile]
Grid item height
Empty values are treated as default values
13ColumnsNumber2
1 [Mobile]
colsnumber2
1 [Mobile]
Number of columns in the custom grid
14GapNumber10gapnumber10Distance between grid items
15Scroll BarBooleanOFFscrollBarbooleanfalseON: Display scroll bar when components placed from grid items overflow
OFF: Hide overflowing parts when components placed from grid items overflow
16Background ColorString
Color Picker
backgroundColorstringCustom grid background color
17BorderBooleanOFFborderbooleanfalseCustom grid border display setting
18Border WidthNumber1borderWidthnumber1Custom grid border width
19Rounded SizeNumber0roundedSizenumber0Custom grid border roundness
20Border ColorString
Color Picker
borderColorstringCustom grid border color
21Border OpacityNumber100borderOpacitynumber100Custom grid border opacity
22Border StyleSelection
1. Solid
2. Dashed
3. Dotted
SolidborderStylestringsolidCustom grid border style
23Grid Item Background ColorString
Color Picker
gridItemBackgroundColorstringGrid item background color
24Grid Item BorderBooleanONgridItemBorderbooleantrueGrid item border display setting
25Grid Item Border WidthNumber1gridItemBorderWidthnumber1Grid item border width
26Grid Item Rounded SizeNumber0gridItemRoundedSizenumber0Grid item border roundness
27Grid Item Border ColorString
Color Picker
gridItemBorderColorstringGrid item border color
28Grid Item Border OpacityNumber100gridItemborderOpacitynumber100Grid item border opacity
29Grid Item Border StyleSelection
1. Solid
2. Dashed
3. Dotted
SolidgridItemborderStylestringsolidGrid item border style
30ElevationNumber0elevationnumber0Grid item z-axis height
31VisibilityBooleanONvisibilitybooleantrueComponent visibility setting
32ValueTable format
[Details 1]
valuearray of objectCustom grid value
33Click EventSelection
1. None
2. Action
Action[When Click Event is None]
Only actions within grid item components are enabled.
[When Click Event is Action]
Only actions on grid cell click are enabled.
34Selected ValueselectedobjectData of the selected grid item
The [selected] property cannot be set by actions.

[Details 1] Value (value)

Gets and sets the value of the entire table in the custom grid. The value format is an array of objects representing rows.
The default state is registered as follows. Register each row using the [Add Row] button.
To delete, select the checkbox and click the [Delete] button.

text_field_1button_1rating_1
Text_1Button_15
Text_2Button_23
Text_3Button_34
Text_4Button_45

When handling data with actions, you can display data in each component of the custom grid by setting the value (value) in array of objects format as shown in the example below. Similarly, the value (value) contains the current display data state of the table in array of objects format.

[
{"button_1":"Button_1","text_field_1":"Text_1","rating_1":"5"},
{"button_1":"Button_2","text_field_1":"Text_2","rating_1":"3"},
{"button_1":"Button_3","text_field_1":"Text_3","rating_1":"4"},
{"button_1":"Button_4","text_field_1":"Text_4","rating_1":"5"}
]
NoGrid Item ComponentCorresponding Property
1Text Inputvalue
2Text Areavalue
3Number Inputvalue
4High Precision Numbervalue
5Search Fieldvalue
6Password Inputvalue
7Select Boxvalue
8Combo Boxvalue
9Date Pickervalue
10DateTime Pickervalue
11Time Pickervalue
12Radio Buttonvalue
13Radio Button Groupvalue
14Checkboxvalue
15Checkbox Groupvalue
16Switchvalue
17Ratingvalue
18Slidervalue
19Buttonlabel
20Typographyvalue
21Rich Textvalue
22Imagevalue
23External Resourcevalue
24Linklabel
25Box-
26Divider-

[Details 2] Getting the Clicked Grid Item from Grid Item Actions

With the custom grid’s click action and actions of components within grid items, you can obtain the grid item where the event occurred through the selected value (selected) property.
The selected value (selected) is a property that can retrieve the selected grid item data.
In custom grid events, one grid item object can be obtained through the selected value (selected) property.

Events

Event NameDescription
onclickTriggered when a grid item is clicked.