@globalpayments/vega 2.26.0 → 2.27.0

package/dist/collection/components/vega-table/vega-table.js

@@ -32,12 +32,14 @@ import { ImmutableMap } from '../../helpers/immutable/immutable-map';
 import { VegaTableRenderModeController } from './slimmers/controllers/vega-table-render-mode-controller';
 import { VegaComponentUsageRuntimeMetricsSlimmer } from '../../helpers/slimmers/component-usage-runtime-metrics';
 import { VegaTableRuntimeMetricsPayloadDefinition } from '../../constants/runtime-metrics-payload-definition/vega-table/runtime-metrics-payload-definition';
+import { TranslationSlimmer } from '../../helpers/slimmers/translation';
 /**
- * @version 1.3.0
+ * @vegaVersion 1.3.0
  */
 export class VegaTable {
   constructor() {
     this.globalSlimmers = {};
+    this.translationSlimmer = new TranslationSlimmer();
     this.vegaTableRenderModeController = new VegaTableRenderModeController();
     this.vegaTableRenderer = new VegaTableRenderer();
     this.vegaTableHeaderRenderer = new VegaTableHeaderRenderer();
@@ -104,14 +106,14 @@ export class VegaTable {
     /**
      * Defines the columns of the table.
      *
-     * @version 1.3.0
+     * @vegaVersion 1.3.0
      */
     this.columns = [];
     /**
      * Contains the data records to be rendered and
      *    displayed within the table.
      *
-     * @version 1.3.0
+     * @vegaVersion 1.3.0
      */
     /* eslint-disable-next-line @stencil/strict-mutable */
     this.dataSource = [];
@@ -122,7 +124,7 @@ export class VegaTable {
      * It allows users to select one or more rows in
      *    the table for further actions or processing.
      *
-     * @version 1.3.0
+     * @vegaVersion 1.3.0
      */
     /* eslint-disable-next-line @stencil/strict-mutable */
     this.rowSelection = null;
@@ -133,7 +135,7 @@ export class VegaTable {
     /**
      * Indicates whether the row is expandable.
      *
-     * @version 1.3.0
+     * @vegaVersion 1.3.0
      */
     this.rowExpandable = false;
     /**
@@ -141,65 +143,65 @@ export class VegaTable {
      *    If enabled, a `vegaRowClick` event will be
      *    dispatched when a row is clicked.
      *
-     * @version 1.3.0
+     * @vegaVersion 1.3.0
      */
     this.rowClickable = false;
     /**
      * Specifies whether dividers should be displayed
      *    between rows in the table.
      *
-     * @version 1.3.0
+     * @vegaVersion 1.3.0
      */
     this.rowDivider = false;
     /**
      * Specifies whether dividers should be displayed
      *    between columns in the table.
      *
-     * @version 1.3.0
+     * @vegaVersion 1.3.0
      */
     this.columnDivider = false;
     /**
      * Specifies whether alternate colors should be applied
      *    to the rows of the table.
      *
-     * @version 1.3.0
+     * @vegaVersion 1.3.0
      */
     this.striped = true;
     /**
      * Specifies the negative space within the table's cells.
      *
-     * @version 1.3.0
+     * @vegaVersion 1.3.0
      */
     this.density = 'default';
     /**
      * Controls the amount of horizontal padding applied to the table.
      *
-     * @version 1.3.0
+     * @vegaVersion 1.3.0
      */
     this.paddingX = ['8px', '8px'];
     /**
      * Specifies whether the table header should be displayed.
      *
-     * @version 1.3.0
+     * @vegaVersion 1.3.0
      */
     this.showHeader = true;
     /**
      * Specifies the pagination configuration.
      *
-     * @version 1.5.0
+     * @vegaVersion 1.5.0
      */
     this.pagination = null;
     /**
      * Provides a customized message or description that is
      *    shown when the table's data source is empty.
      *
-     * @version 1.7.0
+     * @vegaVersion 1.7.0
      */
     this.emptyDescription = 'There is no data to display';
     /**
      * Defines a unique key for each row in the table.
      *
-     * @version 1.9.2
+     * @vegaVersion 1.9.2
      */
     this.rowKey = 'key';
     /**
@@ -207,7 +209,7 @@ export class VegaTable {
      * Has optional property type: single | multiple
      * If not specified, it defaults to multiple column sorting
      *
-     * @version 2.22.0
+     * @vegaVersion 2.22.0
      */
     this.sortConfig = { type: 'multiple' };
   }
@@ -270,7 +272,7 @@ export class VegaTable {
    *    revealing additional content.
    *
    * @param rowKey
-   * @version 1.3.0
+   * @vegaVersion 1.3.0
    */
   async openExpandRow(rowKey) {
     methodPlaceholder(rowKey);
@@ -279,7 +281,7 @@ export class VegaTable {
    * Invoke this method to close the expanded row with the specified `rowKey`.
    *
    * @param rowKey
-   * @version 1.3.0
+   * @vegaVersion 1.3.0
    */
   async closeExpandRow(rowKey) {
     methodPlaceholder(rowKey);
@@ -287,7 +289,7 @@ export class VegaTable {
   /**
    * Invoke this method to close all expanded rows.
    *
-   * @version 1.3.0
+   * @vegaVersion 1.3.0
    */
   async closeAllExpandRow() {
     methodPlaceholder();
@@ -298,7 +300,7 @@ export class VegaTable {
    *    collapsed and collapsing it if it is currently expanded.
    *
    * @param rowKey
-   * @version 1.3.0
+   * @vegaVersion 1.3.0
    */
   async toggleExpandRow(rowKey) {
     methodPlaceholder(rowKey);
@@ -307,7 +309,7 @@ export class VegaTable {
    * Invoke this method to clear the selected row keys,
    *    removing any current selection.
    *
-   * @version 1.3.0
+   * @vegaVersion 1.3.0
    */
   async clearSelection() {
     methodPlaceholder();
@@ -317,7 +319,7 @@ export class VegaTable {
    *    provided an array or list of the keys representing
    *    the currently selected rows.
    *
-   * @version 1.3.0
+   * @vegaVersion 1.3.0
    */
   async getSelection() {
     return methodPlaceholder();
@@ -328,7 +330,7 @@ export class VegaTable {
    *    the desired selected rows.
    *
    * @param {string[]} keys - Row keys to be set as selected.
-   * @version 1.3.0
+   * @vegaVersion 1.3.0
    */
   async setSelection(keys) {
     methodPlaceholder(keys);
@@ -339,7 +341,7 @@ export class VegaTable {
    *
    * @VegaWarning Note: This method only works with editable tables.
    *
-   * @version 1.19.0
+   * @vegaVersion 1.19.0
    */
   async startRowEditMode(rowKey) {
     methodPlaceholder(rowKey);
@@ -350,7 +352,7 @@ export class VegaTable {
    *
    * @VegaWarning Note: This method only works with editable tables.
    *
-   * @version 1.19.0
+   * @vegaVersion 1.19.0
    */
   async stopRowEditMode(rowKey) {
     methodPlaceholder(rowKey);
@@ -362,7 +364,7 @@ export class VegaTable {
    *
    * @VegaWarning Note: This method only works with editable tables.
    *
-   * @version 1.19.0
+   * @vegaVersion 1.19.0
    */
   async stopAllRowEditMode() {
     methodPlaceholder();
@@ -376,7 +378,7 @@ export class VegaTable {
    *
    * @VegaWarning Note: This method only works with editable tables.
    *
-   * @version 1.19.0
+   * @vegaVersion 1.19.0
    */
   async getRowData(rowKey) {
     return methodPlaceholder(rowKey);
@@ -388,7 +390,7 @@ export class VegaTable {
    *
    * @VegaWarning Note: This method only works with editable tables.
    *
-   * @version 1.19.0
+   * @vegaVersion 1.19.0
    */
   async getRowsData() {
     return methodPlaceholder();
@@ -404,7 +406,7 @@ export class VegaTable {
    *
    * @VegaWarning Note: This method only works with editable tables.
    *
-   * @version 1.19.0
+   * @vegaVersion 1.19.0
    */
   async getFormRef(rowKey) {
     return methodPlaceholder(rowKey);
@@ -417,7 +419,7 @@ export class VegaTable {
    *
    * @VegaWarning Note: This method only works with editable tables.
    *
-   * @version 1.19.0
+   * @vegaVersion 1.19.0
    */
   async addNewRow(record = {}) {
     return methodPlaceholder(record);
@@ -431,7 +433,7 @@ export class VegaTable {
    *
    * @VegaWarning Note: This method only works with editable tables.
    *
-   * @version 1.19.0
+   * @vegaVersion 1.19.0
    */
   async saveEditRow(rowKey) {
     return methodPlaceholder(rowKey);
@@ -443,7 +445,7 @@ export class VegaTable {
    *
    * @VegaWarning Note: This method only works with editable tables.
    *
-   * @version 1.19.0
+   * @vegaVersion 1.19.0
    */
   async saveAllEditRows() {
     methodPlaceholder();
@@ -454,7 +456,7 @@ export class VegaTable {
    *
    * @VegaWarning Note: This method only works with editable tables.
    *
-   * @version 1.19.0
+   * @vegaVersion 1.19.0
    */
   async getEditingRowsKey() {
     return methodPlaceholder();
@@ -467,7 +469,7 @@ export class VegaTable {
    *
    * @VegaWarning Note: This method only works with editable tables.
    *
-   * @version 1.19.0
+   * @vegaVersion 1.19.0
    */
   async removeRow(rowKey) {
     methodPlaceholder(rowKey);
@@ -502,7 +504,7 @@ export class VegaTable {
       "optional": false,
       "docs": {
         "tags": [{
-            "name": "version",
+            "name": "vegaVersion",
             "text": "1.3.0"
           }],
         "text": "Defines the columns of the table."
@@ -526,7 +528,7 @@ export class VegaTable {
       "optional": false,
       "docs": {
         "tags": [{
-            "name": "version",
+            "name": "vegaVersion",
             "text": "1.3.0"
           }],
         "text": "Contains the data records to be rendered and\n   displayed within the table."
@@ -550,7 +552,7 @@ export class VegaTable {
       "optional": false,
       "docs": {
         "tags": [{
-            "name": "version",
+            "name": "vegaVersion",
             "text": "1.3.0"
           }],
         "text": "Defines the behavior and options related to\n   row selection in the table.\n\nIt allows users to select one or more rows in\n   the table for further actions or processing."
@@ -569,7 +571,7 @@ export class VegaTable {
       "optional": false,
       "docs": {
         "tags": [{
-            "name": "version",
+            "name": "vegaVersion",
             "text": "1.3.0"
           }],
         "text": "Indicates whether the row is expandable."
@@ -590,7 +592,7 @@ export class VegaTable {
       "optional": false,
       "docs": {
         "tags": [{
-            "name": "version",
+            "name": "vegaVersion",
             "text": "1.3.0"
           }],
         "text": "Specifies whether rows in the table can be clicked.\n   If enabled, a `vegaRowClick` event will be\n   dispatched when a row is clicked."
@@ -611,7 +613,7 @@ export class VegaTable {
       "optional": false,
       "docs": {
         "tags": [{
-            "name": "version",
+            "name": "vegaVersion",
             "text": "1.3.0"
           }],
         "text": "Specifies whether dividers should be displayed\n   between rows in the table."
@@ -632,7 +634,7 @@ export class VegaTable {
       "optional": false,
       "docs": {
         "tags": [{
-            "name": "version",
+            "name": "vegaVersion",
             "text": "1.3.0"
           }],
         "text": "Specifies whether dividers should be displayed\n   between columns in the table."
@@ -653,7 +655,7 @@ export class VegaTable {
       "optional": false,
       "docs": {
         "tags": [{
-            "name": "version",
+            "name": "vegaVersion",
             "text": "1.3.0"
           }],
         "text": "Specifies whether alternate colors should be applied\n   to the rows of the table."
@@ -683,7 +685,7 @@ export class VegaTable {
       "optional": false,
       "docs": {
         "tags": [{
-            "name": "version",
+            "name": "vegaVersion",
             "text": "1.3.0"
           }],
         "text": "Specifies the negative space within the table's cells."
@@ -704,7 +706,7 @@ export class VegaTable {
       "optional": false,
       "docs": {
         "tags": [{
-            "name": "version",
+            "name": "vegaVersion",
             "text": "1.3.0"
           }],
         "text": "Controls the amount of horizontal padding applied to the table."
@@ -723,7 +725,7 @@ export class VegaTable {
       "optional": false,
       "docs": {
         "tags": [{
-            "name": "version",
+            "name": "vegaVersion",
             "text": "1.3.0"
           }],
         "text": "Specifies whether the table header should be displayed."
@@ -749,7 +751,7 @@ export class VegaTable {
       "optional": false,
       "docs": {
         "tags": [{
-            "name": "version",
+            "name": "vegaVersion",
             "text": "1.5.0"
           }],
         "text": "Specifies the pagination configuration."
@@ -768,7 +770,7 @@ export class VegaTable {
       "optional": false,
       "docs": {
         "tags": [{
-            "name": "version",
+            "name": "vegaVersion",
             "text": "1.7.0"
           }],
         "text": "Provides a customized message or description that is\n   shown when the table's data source is empty."
@@ -789,7 +791,7 @@ export class VegaTable {
       "optional": false,
       "docs": {
         "tags": [{
-            "name": "version",
+            "name": "vegaVersion",
             "text": "1.9.2"
           }],
         "text": "Defines a unique key for each row in the table."
@@ -815,7 +817,7 @@ export class VegaTable {
       "optional": true,
       "docs": {
         "tags": [{
-            "name": "version",
+            "name": "vegaVersion",
             "text": "1.29.0"
           }],
         "text": "Customizes the behavior and appearance of the\n   scrollable container that wraps the table."
@@ -838,7 +840,7 @@ export class VegaTable {
       "optional": true,
       "docs": {
         "tags": [{
-            "name": "version",
+            "name": "vegaVersion",
             "text": "2.22.0"
           }],
         "text": "Defines the column sorting options\nHas optional property type: single | multiple\nIf not specified, it defaults to multiple column sorting"
@@ -867,7 +869,7 @@ export class VegaTable {
       "composed": true,
       "docs": {
         "tags": [{
-            "name": "version",
+            "name": "vegaVersion",
             "text": "1.3.0"
           }],
         "text": "An event emitter notifying changes in the table data."
@@ -893,7 +895,7 @@ export class VegaTable {
             "name": "eventSemantics",
             "text": "namespace:native"
           }, {
-            "name": "version",
+            "name": "vegaVersion",
             "text": "2.0.0"
           }],
         "text": "An event emitter notifying changes in the table data."
@@ -916,7 +918,7 @@ export class VegaTable {
       "composed": true,
       "docs": {
         "tags": [{
-            "name": "version",
+            "name": "vegaVersion",
             "text": "1.3.0"
           }],
         "text": "An event emitter notifying the click event of a row\n   in the table."
@@ -942,7 +944,7 @@ export class VegaTable {
             "name": "eventSemantics",
             "text": "namespace:native"
           }, {
-            "name": "version",
+            "name": "vegaVersion",
             "text": "2.0.0"
           }],
         "text": "An event emitter notifying the click event of a row\n   in the table."
@@ -965,7 +967,7 @@ export class VegaTable {
       "composed": true,
       "docs": {
         "tags": [{
-            "name": "version",
+            "name": "vegaVersion",
             "text": "2.24.0"
           }],
         "text": "An event emitter notifying the expanded event of a row\n   in the table."
@@ -991,7 +993,7 @@ export class VegaTable {
             "name": "eventSemantics",
             "text": "namespace:native"
           }, {
-            "name": "version",
+            "name": "vegaVersion",
             "text": "2.24.0"
           }],
         "text": "An event emitter notifying the expanded event of a row\n   in the table."
@@ -1014,7 +1016,7 @@ export class VegaTable {
       "composed": true,
       "docs": {
         "tags": [{
-            "name": "version",
+            "name": "vegaVersion",
             "text": "1.18.0"
           }],
         "text": "An event emitter notifying when the row selection changes."
@@ -1040,7 +1042,7 @@ export class VegaTable {
             "name": "eventSemantics",
             "text": "namespace:native"
           }, {
-            "name": "version",
+            "name": "vegaVersion",
             "text": "2.0.0"
           }],
         "text": "An event emitter notifying when the selection state of all rows changes."
@@ -1063,7 +1065,7 @@ export class VegaTable {
       "composed": true,
       "docs": {
         "tags": [{
-            "name": "version",
+            "name": "vegaVersion",
             "text": "1.18.0"
           }],
         "text": "An event emitter notifying changes in the selection of checkboxes,\n   particularly the \"Select All\" checkbox in the table header."
@@ -1089,7 +1091,7 @@ export class VegaTable {
             "name": "eventSemantics",
             "text": "namespace:native"
           }, {
-            "name": "version",
+            "name": "vegaVersion",
             "text": "2.0.0"
           }],
         "text": "An event emitter notifying changes in the selection of checkboxes,\n   particularly the \"Select All\" checkbox in the table header."
@@ -1112,7 +1114,7 @@ export class VegaTable {
       "composed": true,
       "docs": {
         "tags": [{
-            "name": "version",
+            "name": "vegaVersion",
             "text": "2.23.0"
           }],
         "text": "An event emitter notifying before the selected change when select/deselect one row"
@@ -1138,7 +1140,7 @@ export class VegaTable {
             "name": "eventSemantics",
             "text": "namespace:native"
           }, {
-            "name": "version",
+            "name": "vegaVersion",
             "text": "2.23.0"
           }],
         "text": "An event emitter notifying before the selected change when select/deselect one row"
@@ -1161,7 +1163,7 @@ export class VegaTable {
       "composed": true,
       "docs": {
         "tags": [{
-            "name": "version",
+            "name": "vegaVersion",
             "text": "2.23.0"
           }],
         "text": "An event emitter notifying before the selected change when select/deselect all rows"
@@ -1187,7 +1189,7 @@ export class VegaTable {
             "name": "eventSemantics",
             "text": "namespace:native"
           }, {
-            "name": "version",
+            "name": "vegaVersion",
             "text": "2.23.0"
           }],
         "text": "An event emitter notifying before the selected change when select/deselect all rows"
@@ -1227,7 +1229,7 @@ export class VegaTable {
             "name": "param",
             "text": "rowKey"
           }, {
-            "name": "version",
+            "name": "vegaVersion",
             "text": "1.3.0"
           }]
       }
@@ -1255,7 +1257,7 @@ export class VegaTable {
             "name": "param",
             "text": "rowKey"
           }, {
-            "name": "version",
+            "name": "vegaVersion",
             "text": "1.3.0"
           }]
       }
@@ -1274,7 +1276,7 @@ export class VegaTable {
       "docs": {
         "text": "Invoke this method to close all expanded rows.",
         "tags": [{
-            "name": "version",
+            "name": "vegaVersion",
             "text": "1.3.0"
           }]
       }
@@ -1302,7 +1304,7 @@ export class VegaTable {
             "name": "param",
             "text": "rowKey"
           }, {
-            "name": "version",
+            "name": "vegaVersion",
             "text": "1.3.0"
           }]
       }
@@ -1321,7 +1323,7 @@ export class VegaTable {
       "docs": {
         "text": "Invoke this method to clear the selected row keys,\n   removing any current selection.",
         "tags": [{
-            "name": "version",
+            "name": "vegaVersion",
             "text": "1.3.0"
           }]
       }
@@ -1340,7 +1342,7 @@ export class VegaTable {
       "docs": {
         "text": "Invoke this method to retrieve the selected row keys,\n   provided an array or list of the keys representing\n   the currently selected rows.",
         "tags": [{
-            "name": "version",
+            "name": "vegaVersion",
             "text": "1.3.0"
           }]
       }
@@ -1368,7 +1370,7 @@ export class VegaTable {
             "name": "param",
             "text": "keys - Row keys to be set as selected."
           }, {
-            "name": "version",
+            "name": "vegaVersion",
             "text": "1.3.0"
           }]
       }
@@ -1393,7 +1395,7 @@ export class VegaTable {
             "name": "VegaWarning",
             "text": "Note: This method only works with editable tables."
           }, {
-            "name": "version",
+            "name": "vegaVersion",
             "text": "1.19.0"
           }]
       }
@@ -1418,7 +1420,7 @@ export class VegaTable {
             "name": "VegaWarning",
             "text": "Note: This method only works with editable tables."
           }, {
-            "name": "version",
+            "name": "vegaVersion",
             "text": "1.19.0"
           }]
       }
@@ -1440,7 +1442,7 @@ export class VegaTable {
             "name": "VegaWarning",
             "text": "Note: This method only works with editable tables."
           }, {
-            "name": "version",
+            "name": "vegaVersion",
             "text": "1.19.0"
           }]
       }
@@ -1475,7 +1477,7 @@ export class VegaTable {
             "name": "VegaWarning",
             "text": "Note: This method only works with editable tables."
           }, {
-            "name": "version",
+            "name": "vegaVersion",
             "text": "1.19.0"
           }]
       }
@@ -1501,7 +1503,7 @@ export class VegaTable {
             "name": "VegaWarning",
             "text": "Note: This method only works with editable tables."
           }, {
-            "name": "version",
+            "name": "vegaVersion",
             "text": "1.19.0"
           }]
       }
@@ -1532,7 +1534,7 @@ export class VegaTable {
             "name": "VegaWarning",
             "text": "Note: This method only works with editable tables."
           }, {
-            "name": "version",
+            "name": "vegaVersion",
             "text": "1.19.0"
           }]
       }
@@ -1570,7 +1572,7 @@ export class VegaTable {
             "name": "VegaWarning",
             "text": "Note: This method only works with editable tables."
           }, {
-            "name": "version",
+            "name": "vegaVersion",
             "text": "1.19.0"
           }]
       }
@@ -1595,7 +1597,7 @@ export class VegaTable {
             "name": "VegaWarning",
             "text": "Note: This method only works with editable tables."
           }, {
-            "name": "version",
+            "name": "vegaVersion",
             "text": "1.19.0"
           }]
       }
@@ -1617,7 +1619,7 @@ export class VegaTable {
             "name": "VegaWarning",
             "text": "Note: This method only works with editable tables."
           }, {
-            "name": "version",
+            "name": "vegaVersion",
             "text": "1.19.0"
           }]
       }
@@ -1639,7 +1641,7 @@ export class VegaTable {
             "name": "VegaWarning",
             "text": "Note: This method only works with editable tables."
           }, {
-            "name": "version",
+            "name": "vegaVersion",
             "text": "1.19.0"
           }]
       }
@@ -1670,7 +1672,7 @@ export class VegaTable {
             "name": "VegaWarning",
             "text": "Note: This method only works with editable tables."
           }, {
-            "name": "version",
+            "name": "vegaVersion",
             "text": "1.19.0"
           }]
       }
@@ -1736,6 +1738,9 @@ export class VegaTable {
 __decorate([
   InjectVegaGlobalSlimmer()
 ], VegaTable.prototype, "globalSlimmers", void 0);
+__decorate([
+  InjectVegaSlimmer()
+], VegaTable.prototype, "translationSlimmer", void 0);
 __decorate([
   InjectVegaSlimmer()
 ], VegaTable.prototype, "vegaTableRenderModeController", void 0);