@cdmx/wappler_ag_grid 1.5.13 → 1.6.0

package/README.md

@@ -33,51 +33,54 @@ To use the "Custom" theme, copy "ag-theme-custom.css" to public/css/ag-theme-cus
 4. **Case-Insensitive Sort**: Specifies if the columns are sorted in case-insensitive manner. (Default: false)
 5. **Filter**: Specifies if the column has a filter. (Default: true)
 6. **Floating Filter**: Specifies if the column has a floating filter. (Default: true)
-7. **CSV Export**: Specifies if Export to CSV is enabled. (Default: true)
-8. **Enable RTL**: Enabled Right to Left, used for Hebrew and Arabic. (Default: false)
-9. **Column Hover Highlight**: Specifies column hover highlighting. (Default: true)
-10. **Suppress Row Deselection**: Specifies if rows can be deselected. (Default: false)
-11. **Pagination**: Enables pagination. (Default: true)
-12. **Auto Pagination**: Enables automatic pagination. (Default: false)
-13. **Page Limit Selectors**: Allowed selectors for for page size. Set to false to hide the page size selector. (Default: [20,50,100] ).
-14. **Page Limit**: Number of rows to show per page. (Default: 20)
-15. **Row Selection**: Row Selection (single or multiple).
+7. **Editiable Cells**: Makes cells editable. (Default: false)
+8. **Editiable Rows**: Makes row data editable. (Default: false)
+9. **CSV Export**: Specifies if Export to CSV is enabled. (Default: true)
+10. **Enable RTL**: Enabled Right to Left, used for Hebrew and Arabic. (Default: false)
+11. **Column Hover Highlight**: Specifies column hover highlighting. (Default: true)
+12. **Suppress Row Deselection**: Specifies if rows can be deselected. (Default: false)
+13. **Pagination**: Enables pagination. (Default: true)
+14. **Auto Pagination**: Enables automatic pagination. (Default: false)
+15. **Page Limit Selectors**: Allowed selectors for for page size. Set to false to hide the page size selector. (Default: [20,50,100] ).
+16. **Page Limit**: Number of rows to show per page. (Default: 20)
+17. **Row Selection**: Row Selection (single or multiple).
    - "Single"
    - "Multiple" (Default)
-16. **Timezone**: Timezone for Date Fields. Select the appropriate timezone from the dropdown list. (Default: Local)
-17. **Date Format**: Date Format for displaying date values. (Default: "dd/MM/yyyy hh:mm A")
-18. **Filder Field ID**: Specifies the field ID of the search field when using grid quick filter. Applicable when using Quick Filter feature of AG Grid, called from Dynamic Events on change event on the field. (Default: search_field)
-19. **Loading Overlay**: This enables loading overlay. (Default: false)
-20. **Loading Overlay Duration**: This sets loading overlay duration in ms. (Default: 500)
-21. **Sticky Header and Horizontal Scrollbar**:  Optionally specify the header offset and topbar class.
+18. **Timezone**: Timezone for Date Fields. Select the appropriate timezone from the dropdown list. (Default: Local)
+19. **Date Format**: Date Format for displaying date values. (Default: "dd/MM/yyyy hh:mm A")
+20. **Filter Field ID**: Specifies the field ID of the search field when using grid quick filter. Applicable when using Quick Filter feature of AG Grid, called from Dynamic Events on change event on the field. (Default: search_field)
+21. **Loading Overlay**: This enables loading overlay. (Default: false)
+22. **Loading Overlay Duration**: This sets loading overlay duration in ms. (Default: 500)
+23. **Sticky Header and Horizontal Scrollbar**:  Optionally specify the header offset and topbar class.
    - Fixed Header: Enables sticky header. (Default: false)
    - Header Offset: Specifies offset from the top of the viewport area (Optional). (Default: 100)
    - Topbar Class: Specify class, e.g., "topbar", to measure the offset from (Optional). (Default: "topbar")
    - Topbar Offset: Specify topbar offset (Default: 80)
    - Fixed Horizontal Scroll: Enables Hovering horizontal scrollbar which stays at the bottom all the time. (Default: false)
    - Fixed Horizontal Scroll Width: Fixed horizontal scroll width percentage. (Default: 80%)
-22. **Row Height**: Height of each row in pixels. (Default: Auto)
-23. **Header Height**: Height of the header row in pixels. (Default: Auto)
-24. **Wrap Header Text**: This will cause long headers to wrap. (Default: true)
-25. **Auto Header Height**: The header height is automatically set based on the content of the header. (Default: true)
-26. **Auto Height**: The height is automatically set based on the content of the cells. (Default: false)
-27. **Wrap Text**: This will cause long texts to wrap in the cells. (Default: false)
-28. **Suppress Row Click Selection**: Disables row selection on row click. (Default: false)
-29. **Suppress Menu Hide**: Prevents hiding the column menu. (Default: false)
-30. **Suppress Movable Columns**: Disables moving columns. (Default: false)
-31. **Enable Cell Expressions**: Enables expressions in cell values. (Default: false)
-32. **Animate Rows**: Enables row animation on data changes. (Default: false)
-33. **Suppress Aggregation Function in Header**: Hides the aggregation function in column headers. (Default: false)
-34. **Suppress Clipboard Paste**: Disables pasting data from the clipboard. (Default: false)
-35. **Suppress Scroll on New Data**: Prevents scrolling to newly added data. (Default: false)
-36. **Suppress Property Names Check**: Disables checking for duplicate property names. (Default: false)
-37. **Hide ID Field**: Hides the ID Field in the Grid. (Default: false)
-38. **ID Present**: Uses ID field data for performing transactional updates on the Grid. Required to be enabled when perfomring transaction updates (Reload on Grid). (Default: false)
-39. **Numeric Column Align**: Align numeric columns to the right. (Default: false)
-40. **Row Click Events**: Enables row click events. This can be used in Dynamic events => Grid Events => Row Clicked. (Default: false)
-41. **Row Double Click Events**: Enables row double click events. This can be used in Dynamic events => Grid Events => Row Double Clicked. (Default: false)
-42. **Enable Row Selection**: Enables row selection. This can be used in Dynamic events => Grid Events => Checkbox Checked || Checkbox Unchecked. (Default: false)
-43. **Enable Row Status Toggle**: Enables row status toggle events. This can be used in Dynamic events => Grid Events => Checkbox Checked || Checkbox Unchecked. (Default: false)
+24. **Row Height**: Height of each row in pixels. (Default: Auto)
+25. **Header Height**: Height of the header row in pixels. (Default: Auto)
+26. **Wrap Header Text**: This will cause long headers to wrap. (Default: true)
+27. **Auto Header Height**: The header height is automatically set based on the content of the header. (Default: true)
+28. **Auto Height**: The height is automatically set based on the content of the cells. (Default: false)
+29. **Wrap Text**: This will cause long texts to wrap in the cells. (Default: false)
+30. **Center Align (V)**: Specifies if the cell data should be vertically centered. (Default: false)
+31. **Center Align (H)**: Specifies if the cell data should be vertically centered. (Default: false)
+32. **Suppress Row Click Selection**: Disables row selection on row click. (Default: false)
+33. **Suppress Menu Hide**: Prevents hiding the column menu. (Default: false)
+34. **Suppress Movable Columns**: Disables moving columns. (Default: false)
+35. **Enable Cell Expressions**: Enables expressions in cell values. (Default: false)
+36. **Animate Rows**: Enables row animation on data changes. (Default: false)
+37. **Suppress Aggregation Function in Header**: Hides the aggregation function in column headers. (Default: false)
+38. **Suppress Clipboard Paste**: Disables pasting data from the clipboard. (Default: false)
+39. **Suppress Scroll on New Data**: Prevents scrolling to newly added data. (Default: false)
+40. **Suppress Property Names Check**: Disables checking for duplicate property names. (Default: false)
+41. **Hide ID Field**: Hides the ID Field in the Grid. (Default: false)
+42. **Numeric Column Align**: Align numeric columns to the right. (Default: false)
+43. **Row Click Events**: Enables row click events. This can be used in Dynamic events => Grid Events => Row Clicked. (Default: false)
+44. **Row Double Click Events**: Enables row double click events. This can be used in Dynamic events => Grid Events => Row Double Clicked. (Default: false)
+45. **Enable Row Selection**: Enables row selection. This can be used in Dynamic events => Grid Events => Checkbox Checked || Checkbox Unchecked. (Default: false)
+46. **Enable Row Status Toggle**: Enables row status toggle events. This can be used in Dynamic events => Grid Events => Checkbox Checked || Checkbox Unchecked. (Default: false)
 
 # Data Type Overrides
 

package/app_connect/components.hjson

@@ -176,6 +176,22 @@
               "defaultValue": true,
               "help": "Specifies if the column has a floating filter"
             },
+            {
+              "name": "cellEditable",
+              "attribute": "dmx-bind:cell_editable",
+              "title": "Editable Cells",
+              "type": "boolean",
+              "defaultValue": false,
+              "help": "Makes cells editable."
+            },
+             {
+              "name": "rowEditable",
+              "attribute": "dmx-bind:row_editable",
+              "title": "Row Editable",
+              "type": "boolean",
+              "defaultValue": false,
+              "help": "Makes entire row editable."
+            },
             {
               "name": "exportToCSV",
               "attribute": "dmx-bind:export_to_csv",
@@ -451,6 +467,22 @@
               "defaultValue": false,
               "help": "This will cause long texts to wrap in the cells."
             },
+            {
+              "name": "vCenterCellData",
+              "attribute": "dmx-bind:vert_center_cell_data",
+              "title": "Center Align (V)",
+              "type": "boolean",
+              "defaultValue": false,
+              "help": "Specifies if the cell data should be vertically centered."
+            },
+            {
+              "name": "hCenterCellData",
+              "attribute": "dmx-bind:horz_center_cell_data",
+              "title": "Center Align (H)",
+              "type": "boolean",
+              "defaultValue": false,
+              "help": "Specifies if the cell data should be horizontally centered."
+            },
             {
               "name": "autoHeight",
               "attribute": "dmx-bind:auto_height",
@@ -539,14 +571,6 @@
               "defaultValue": false,
               "help": "Hides the ID Field in Grid"
             },
-            {
-              "name": "idPreset",
-              "attribute": "dmx-bind:id_present",
-              "title": "ID Present",
-              "type": "boolean",
-              "defaultValue": false,
-              "help": "Uses ID field data for performing transactional updates on the Grid. Required to be enabled when perfomring transaction updates (Reload on Grid)"
-            },
             {
               "name": "numericColumnAlign",
               "attribute": "dmx-bind:numeric_column_align",
@@ -2804,6 +2828,74 @@
         "dmx-ag-grid": true
       }
     },
+    {
+      "name": "dmx-ag-grid-cell-edited",
+      "attributeStartsWith": "dmx-on",
+      "attribute": "cell_data_edited",
+      "display": "fieldset",
+      "title": "Cell Data Edited",
+      "icon": "fa fa-lg fa-chevron-right",
+      "groupTitle": "Grid Events",
+      "groupIcon": "fa fa-lg fa-cubes",
+      "defaultValue": false,
+      "show": [
+        "cellDataUpdated"
+      ],
+      "noChangeOnHide": true,
+      "type": "boolean",
+      "groupEnabler": true,
+      "children": [
+        {
+          "name": "cellDataUpdated",
+          "attributeStartsWith": "dmx-on",
+          "attribute": "cell_data_edited",
+          "isValue": true,
+          "actionsPicker": true,
+          "title": "Action:",
+          "type": "text",
+          "help": "Choose the action to execute.",
+          "defaultValue": "",
+          "initDisplay": "none"
+        }
+      ],
+      "allowedOn": {
+        "dmx-ag-grid": true
+      }
+    },
+    {
+      "name": "dmx-ag-grid-row-edited",
+      "attributeStartsWith": "dmx-on",
+      "attribute": "row_data_edited",
+      "display": "fieldset",
+      "title": "Row Data Edited",
+      "icon": "fa fa-lg fa-chevron-right",
+      "groupTitle": "Grid Events",
+      "groupIcon": "fa fa-lg fa-cubes",
+      "defaultValue": false,
+      "show": [
+        "rowDataUpdated"
+      ],
+      "noChangeOnHide": true,
+      "type": "boolean",
+      "groupEnabler": true,
+      "children": [
+        {
+          "name": "rowDataUpdated",
+          "attributeStartsWith": "dmx-on",
+          "attribute": "row_data_edited",
+          "isValue": true,
+          "actionsPicker": true,
+          "title": "Action:",
+          "type": "text",
+          "help": "Choose the action to execute.",
+          "defaultValue": "",
+          "initDisplay": "none"
+        }
+      ],
+      "allowedOn": {
+        "dmx-ag-grid": true
+      }
+    },
     {
       "name": "dmx-ag-grid-checkbox-checked",
       "attributeStartsWith": "dmx-on",

package/dmx-ag-grid.js

@@ -30,6 +30,8 @@ dmx.Component('ag-grid', {
     auto_header_height: { type: Boolean, default: true },
     wrap_text: { type: Boolean, default: false },
     auto_height: { type: Boolean, default: false },
+    vert_center_cell_data: { type: Boolean, default: false },
+    horz_center_cell_data: { type: Boolean, default: false },
     data_changes: { type: Array, default: [] },
     display_data_changes: { type: Array, default: [] },
     js_data_changes: { type: Array, default: [] },
@@ -57,7 +59,6 @@ dmx.Component('ag-grid', {
     suppress_scroll_on_new_data: { type: Boolean, default: false },
     suppress_property_names_check: { type: Boolean, default: false },
     hide_id_field: { type: Boolean, default: false },
-    id_present: { type: Boolean, default: false },
     numeric_column_align: { type: Boolean, default: false },
     enable_rtl: { type: Boolean, default: false },
     locale_text: { type: String, default: null },
@@ -67,6 +68,8 @@ dmx.Component('ag-grid', {
     amount_field_precision: { type: Number, default: 2 },
     min_width: { type: Number, default: 150 },
     sortable: { type: Boolean, default: true },
+    cell_editable: { type: Boolean, default: false },
+    row_editable: { type: Boolean, default: false },
     ci_sort: { type: Boolean, default: false },
     resizable: { type: Boolean, default: true },
     filter: { type: Boolean, default: true },
@@ -394,6 +397,7 @@ dmx.Component('ag-grid', {
     let cellRenderer;
     const gridThemeClass = options.dark_mode ? `${options.grid_theme}-dark` : options.grid_theme;
     this.$node.innerHTML = `<div id=${options.id}-grid class="${gridThemeClass}"></div>`;
+    let idFieldPresent = false;
     if (!rowData || rowData.length === 0) {
       console.error('No row data provided.');
       return;
@@ -958,6 +962,7 @@ dmx.Component('ag-grid', {
       columnDefs = this.props.column_defs;
     } else {
       const firstRow = rowData[0];
+      idFieldPresent = Object.keys(firstRow).includes('id');
       columnDefs = Object.keys(firstRow).map(key => {
         // Assuming rowData is an array of objects
         const values = rowData.map(row => row[key]);
@@ -1187,6 +1192,7 @@ dmx.Component('ag-grid', {
           checkboxSelection: true,
           showDisabledCheckboxes: true,
           resizable: false,
+          editable: false,
           width: 50,
           maxWidth: 50, 
           suppressMenu: true
@@ -1204,6 +1210,7 @@ dmx.Component('ag-grid', {
         minWidth: options.actions_column_min_width,
         maxWidth: options.actions_column_max_width,
         autoHeight: true,
+        editable: false,
         pinned: (options.pin_actions ? options.actions_column_position: undefined),
         cellRendererParams: {
           buttons: [],
@@ -1292,7 +1299,7 @@ dmx.Component('ag-grid', {
       localeText = AG_GRID_LOCALE_PT
     }
     const gridOptions = {
-      ...(options.id_present ? { getRowId: params => params.data.id } : {}),
+      ...(idFieldPresent ? { getRowId: params => params.data.id } : {}),
       columnDefs: (groupedColumnDefs && groupedColumnDefs.length > 0) ? groupedColumnDefs : columnDefs,
       localeText: localeText,
       enableRtl: options.enable_rtl,
@@ -1310,8 +1317,10 @@ dmx.Component('ag-grid', {
         autoHeight: options.auto_height,
         filter: options.filter,
         sortable: options.sortable,
+        editable: options.cell_editable,
         floatingFilter: options.floating_filter
       },
+      editType: (options.row_editable ? 'fullRow': undefined),
       domLayout: this.props.dom_layout,
       enableCellTextSelection: true,
       rowSelection: this.props.row_selection,
@@ -1389,6 +1398,20 @@ dmx.Component('ag-grid', {
           updateHoveringBarStyles();
         }
       },
+      onCellValueChanged: (params) => {
+        this.set('data', params.data);
+        this.set('id', params.data.id);
+        dmx.nextTick(function() {
+          this.dispatchEvent('cell_data_edited');
+        }, this);
+      },
+      onRowValueChanged: (params) => {
+          this.set('data', params.data);
+          this.set('id', params.data.id);
+          dmx.nextTick(function() {
+            this.dispatchEvent('row_data_edited');
+          }, this);
+      },
       components: {
         clickCellRenderer: clickCellRenderer,
         checkboxCellRenderer: checkboxCellRenderer,
@@ -1509,6 +1532,29 @@ dmx.Component('ag-grid', {
       }
 
     const gridElement = document.getElementById(options.id+'-grid');
+    if (options.vert_center_cell_data || options.horz_center_cell_data) {
+      const styleElement = document.createElement('style');
+      if (options.vert_center_cell_data) {
+          styleElement.textContent += `
+              .ag-cell {
+                  display: flex;
+                  align-items: center;
+              }
+          `;
+      }
+      if (options.horz_center_cell_data) {
+          styleElement.textContent += `
+              .ag-cell {
+                  display: flex;
+                  justify-content: center;
+              }
+              .ag-header-cell-label {
+                  justify-content: center;
+              }
+          `;
+      }
+      gridElement.appendChild(styleElement);
+   }
     if (options.compact_view) {
       gridElement.style.setProperty('--ag-grid-size', `${options.compact_view_grid_size}`+'px');
       gridElement.style.setProperty('--ag-list-item-height', `${options.compact_view_item_height}`+'px');
@@ -1604,9 +1650,8 @@ dmx.Component('ag-grid', {
       }
     }
     function updateHoveringBarStyles() {
-      const existingStyle = document.getElementById('hovering-bar-style');
+      const existingStyle = gridElement.querySelector('#hovering-bar-style');
       if (options.fixed_horizontal_scroll) {
-        // Create a new style element
         const styleElement = document.createElement('style');
         styleElement.id = 'hovering-bar-style';
         const agRootWrapper = gridElement.querySelector('.ag-root-wrapper');
@@ -1623,7 +1668,7 @@ dmx.Component('ag-grid', {
         if (existingStyle) {
           existingStyle.parentNode.replaceChild(styleElement, existingStyle);
         } else {
-          document.head.appendChild(styleElement);
+          gridElement.appendChild(styleElement);
         }
       } else if (existingStyle) {
         // Remove the style element if it exists
@@ -1728,6 +1773,8 @@ dmx.Component('ag-grid', {
     row_clicked: Event,
     row_double_clicked: Event,
     cell_clicked: Event,
+    cell_data_edited: Event,
+    row_data_edited: Event,
     row_checkbox_checked: Event,
     row_checkbox_unchecked: Event,
     row_status_enabled: Event,

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@cdmx/wappler_ag_grid",
-    "version": "1.5.13",
+    "version": "1.6.0",
     "type": "module",
     "description": "App Connect module for AG Grid Table Generation.",
     "license": "MIT",