@globalpayments/vega 2.24.0 → 2.24.2

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

@@ -25,6 +25,9 @@ import { createDeprecatedPropertySlimmer, } from '../../helpers/slimmers/depreca
 import { VegaComponentUsageRuntimeMetricsSlimmer } from '../../helpers/slimmers/component-usage-runtime-metrics';
 import { VegaModalRuntimeMetricsPayloadDefinition } from '../../constants/runtime-metrics-payload-definition/vega-modal/runtime-metrics-payload-definition';
 import { VegaNestedModalController } from './slimmers/controllers/vega-nested-modal-controller';
+/**
+ * @version 1.0.6
+ */
 export class VegaModal {
   constructor() {
     this.globalSlimmers = {};
@@ -61,45 +64,64 @@ export class VegaModal {
      * _Note_:
      *    When changing this value, a page refresh is required
      *    for the changes to take effect.
+     *
+     * @version 1.0.6
      */
     this.backdrop = 'default';
     /**
      * Determines whether the modal is initially open.
+     *
+     * @version 1.0.6
      */
+    /* eslint-disable-next-line @stencil/strict-mutable */
     this.open = false;
     /**
      * Specifies whether the modal uses an animated transition
      *    when it appears.
+     *
+     * @version 1.0.11
      */
     this.animation = false;
     /**
      * Represents the title displayed within the modal.
+     *
+     * @version 1.3.0
      */
     this.modalTitle = '';
     /**
      * Specifies the background color of the modal's backdrop.
+     *
+     * @version 1.3.0
      */
     this.backdropColor = 'default';
     /**
      * Determines whether the modal is vertically centered
      *    on the screen.
      * @deprecated This property will be removed soon and replaced by prop isVerticallyCentered
+     *
+     * @version 1.3.0
      */
     this.isVerticallyCenter = false;
     /**
      * Determines whether the modal is vertically centered
      *    on the screen.
+     *
+     * @version 2.2.0
      */
     this.isVerticallyCentered = false;
     /**
      * Determines whether the modal displays a close button to
      *    allow hiding or closing of the modal.
+     *
+     * @version 1.3.0
      */
     this.showCloseButton = true;
     /**
      * Specifies the amount of space or padding within the modal.
      *
      * It can be set as a ResponsiveType or any size value.
+     *
+     * @version 1.0.10
      */
     this.padding = 'size-24';
     /**
@@ -109,6 +131,8 @@ export class VegaModal {
      * If the callback function returns `true`, the modal will be closed.
      *
      * If the callback function returns `false` or does not return any value, the modal will remain open.
+     *
+     * @version 1.22.0
      */
     this.handleClose = undefined;
     /**
@@ -195,7 +219,9 @@ export class VegaModal {
   /* The below method is e2e-test covered in
    * @see{module:vega-modal-toggle-interactive-e2e}
    */
-  /* istanbul ignore next */
+  /* istanbul ignore next *
+   * @version 1.0.6
+   */
   async modal(option) {
     switch (option) {
       case 'show':
@@ -494,7 +520,10 @@ export class VegaModal {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.0.6"
+          }],
         "text": "Provides options for controlling the behavior of the backdrop.\n- `default`:\n     indicates that the user can close the modal\n     by clicking on the backdrop.\n- `static`:\n     means that the user cannot close the modal by\n     clicking on the backdrop.\n- `none`:\n     specifies that the backdrop will not be rendered.\n\n_Note_:\n   When changing this value, a page refresh is required\n   for the changes to take effect."
       },
       "attribute": "backdrop",
@@ -521,7 +550,10 @@ export class VegaModal {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.0.6"
+          }],
         "text": "Determines the size of the modal.\n\nIt can be specified as a number, a percentage string ending with \"%\",\n   or a ResponsiveType.\n\nIt is important to note that there are different maximum widths\n   for modal windows based on the viewport size. If the specified size exceeds\n   the maximum width, the maximum modal width will be used instead."
       },
       "attribute": "size",
@@ -538,7 +570,10 @@ export class VegaModal {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.0.6"
+          }],
         "text": "Determines whether the modal is initially open."
       },
       "attribute": "open",
@@ -556,7 +591,10 @@ export class VegaModal {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.0.11"
+          }],
         "text": "Specifies whether the modal uses an animated transition\n   when it appears."
       },
       "attribute": "animation",
@@ -574,7 +612,10 @@ export class VegaModal {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.3.0"
+          }],
         "text": "Represents the title displayed within the modal."
       },
       "attribute": "modal-title",
@@ -597,7 +638,10 @@ export class VegaModal {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.3.0"
+          }],
         "text": "Specifies the background color of the modal's backdrop."
       },
       "attribute": "backdrop-color",
@@ -618,6 +662,9 @@ export class VegaModal {
         "tags": [{
             "name": "deprecated",
             "text": "This property will be removed soon and replaced by prop isVerticallyCentered"
+          }, {
+            "name": "version",
+            "text": "1.3.0"
           }],
         "text": "Determines whether the modal is vertically centered\n   on the screen."
       },
@@ -636,7 +683,10 @@ export class VegaModal {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "2.2.0"
+          }],
         "text": "Determines whether the modal is vertically centered\n   on the screen."
       },
       "attribute": "is-vertically-centered",
@@ -654,7 +704,10 @@ export class VegaModal {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.3.0"
+          }],
         "text": "Determines whether the modal displays a close button to\n   allow hiding or closing of the modal."
       },
       "attribute": "show-close-button",
@@ -681,7 +734,10 @@ export class VegaModal {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.0.10"
+          }],
         "text": "Specifies the amount of space or padding within the modal.\n\nIt can be set as a ResponsiveType or any size value."
       },
       "attribute": "padding",
@@ -704,7 +760,10 @@ export class VegaModal {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.4.0"
+          }],
         "text": "Defines the maximum height of the content within\n   the modal element."
       },
       "attribute": "content-max-height",
@@ -721,7 +780,10 @@ export class VegaModal {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.22.0"
+          }],
         "text": "Provides a callback function that is triggered when a user clicks the\n   close button located in the top right corner of the modal.\n\nIf the callback function returns `true`, the modal will be closed.\n\nIf the callback function returns `false` or does not return any value, the modal will remain open."
       },
       "defaultValue": "undefined"
@@ -737,7 +799,10 @@ export class VegaModal {
       "cancelable": true,
       "composed": true,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.0.10"
+          }],
         "text": "An event emitter notifying the modal close event."
       },
       "complexType": {
@@ -755,6 +820,9 @@ export class VegaModal {
         "tags": [{
             "name": "eventSemantics",
             "text": "namespace:native"
+          }, {
+            "name": "version",
+            "text": "2.0.0"
           }],
         "text": "An event emitter notifying the modal close event."
       },
@@ -770,7 +838,10 @@ export class VegaModal {
       "cancelable": true,
       "composed": true,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.0.10"
+          }],
         "text": "An event emitter notifying the modal open event."
       },
       "complexType": {
@@ -788,6 +859,9 @@ export class VegaModal {
         "tags": [{
             "name": "eventSemantics",
             "text": "namespace:native"
+          }, {
+            "name": "version",
+            "text": "2.0.0"
           }],
         "text": "An event emitter notifying the modal open event. The event name is not `open` because already has a property `open`"
       },

package/dist/collection/components/vega-nav/vega-left-nav/vega-left-nav.js

@@ -20,6 +20,9 @@ import mainContentStyle from './vega-left-nav-content.css';
 import { VegaLeftNavAutoCollapseController } from './slimmers/controllers/vega-left-nav-auto-collapse-controller';
 import { VegaComponentUsageRuntimeMetricsSlimmer } from '../../../helpers/slimmers/component-usage-runtime-metrics';
 import { VegaLeftNavRuntimeMetricsPayloadDefinition } from '../../../constants/runtime-metrics-payload-definition/vega-left-nav/runtime-metrics-payload-definition';
+/**
+ * @version 1.31.0
+ */
 export class VegaLeftNav {
   constructor() {
     this.globalSlimmers = {};
@@ -36,18 +39,24 @@ export class VegaLeftNav {
     this.openState = 'close';
     /**
      * Determines whether the left navigation is expanded or collapsed.
+     *
+     * @version 1.39.2
      */
-    // eslint-disable-next-line @stencil/strict-mutable
+    /* eslint-disable-next-line @stencil/strict-mutable */
     this.open = false;
     /**
      * Specifies the configuration options for the header within the left-nav.
      *
      * You can use this property to define a custom title and subtitle.
+     *
+     * @version 1.31.0
      */
     this.headerConfig = {};
     /**
      * Provides additional information or context in the form of
      *    a footnote in the left-nav footer.
+     *
+     * @version 1.31.0
      */
     this.footnote = '';
     /**
@@ -60,9 +69,13 @@ export class VegaLeftNav {
      *    property is set to `false` within the `vega-left-nav` component. Additionally, enclose all content
      *    within an element possessing the class `vega-left-nav-content` immediately following the
      *    `vega-left-nav` component.
+     *
+     * @version 1.33.0
      */
     this.showAsOverlay = true;
-    /** Determines whether the left navigation automatically collapses when the left navigation link is clicked in overlay mode. */
+    /** Determines whether the left navigation automatically collapses when the left navigation link is clicked in overlay mode. *
+     * @version 2.7.0
+     */
     this.autoCollapseOnOverlay = false;
   }
   watchOpenState() {
@@ -76,6 +89,8 @@ export class VegaLeftNav {
   }
   /**
    * Invoke this method to toggle the left-nav's open state.
+   *
+   * @version 1.31.0
    */
   async toggle() {
     methodPlaceholder();
@@ -107,7 +122,10 @@ export class VegaLeftNav {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.39.2"
+          }],
         "text": "Determines whether the left navigation is expanded or collapsed."
       },
       "attribute": "open",
@@ -130,7 +148,10 @@ export class VegaLeftNav {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.31.0"
+          }],
         "text": "Specifies the configuration options for the header within the left-nav.\n\nYou can use this property to define a custom title and subtitle."
       },
       "defaultValue": "{}"
@@ -151,7 +172,10 @@ export class VegaLeftNav {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.31.0"
+          }],
         "text": "Specifies source data used to generate the links and\n   groups structure in the left-nav."
       }
     },
@@ -166,7 +190,10 @@ export class VegaLeftNav {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.31.0"
+          }],
         "text": "Provides additional information or context in the form of\n   a footnote in the left-nav footer."
       },
       "attribute": "footnote",
@@ -184,7 +211,10 @@ export class VegaLeftNav {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.33.0"
+          }],
         "text": "Determines whether the left-nav should appear as an overlay,\n   accompanied by a backdrop that darkens the content on the page.\n\nThis property has no effect on breakpoints smaller than the desktop size.\n\nNote: To use the backdrop-free feature when the left navigation is open, ensure the `show-as-overlay`\n   property is set to `false` within the `vega-left-nav` component. Additionally, enclose all content\n   within an element possessing the class `vega-left-nav-content` immediately following the\n   `vega-left-nav` component."
       },
       "attribute": "show-as-overlay",
@@ -202,8 +232,11 @@ export class VegaLeftNav {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
-        "text": "Determines whether the left navigation automatically collapses when the left navigation link is clicked in overlay mode."
+        "tags": [{
+            "name": "version",
+            "text": "2.7.0"
+          }],
+        "text": "Determines whether the left navigation automatically collapses when the left navigation link is clicked in overlay mode. *"
       },
       "attribute": "auto-collapse-on-overlay",
       "reflect": false,
@@ -220,7 +253,10 @@ export class VegaLeftNav {
       "cancelable": true,
       "composed": true,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.31.0"
+          }],
         "text": "An event emitter notifying that the left-nav's open state has changed."
       },
       "complexType": {
@@ -238,6 +274,9 @@ export class VegaLeftNav {
         "tags": [{
             "name": "eventSemantics",
             "text": "namespace:native"
+          }, {
+            "name": "version",
+            "text": "2.0.0"
           }],
         "text": "An event emitter notifying that the left-nav's open state has changed."
       },
@@ -261,7 +300,10 @@ export class VegaLeftNav {
       },
       "docs": {
         "text": "Invoke this method to toggle the left-nav's open state.",
-        "tags": []
+        "tags": [{
+            "name": "version",
+            "text": "1.31.0"
+          }]
       }
     }
   }; }

package/dist/collection/components/vega-nav/vega-left-nav-group/vega-left-nav-group.js

@@ -12,6 +12,9 @@ import { VegaLeftNavGroupController } from './slimmers/controllers/vega-left-nav
 import { createEventEmitSlimmer, } from '../../../helpers/event-manager/slimmers/event-emit-slimmer';
 import { VegaGroupClick } from '../../../helpers/event-manager/event-id/vega-event-id';
 import { VegaComponentUsageRuntimeMetricsSlimmer } from '../../../helpers/slimmers/component-usage-runtime-metrics';
+/**
+ * @version 1.31.0
+ */
 export class VegaLeftNavGroup {
   constructor() {
     this.globalSlimmers = {};
@@ -19,7 +22,9 @@ export class VegaLeftNavGroup {
     this.controller = new VegaLeftNavGroupController();
     this.groupClickEventEmitter = createEventEmitSlimmer(VegaLeftNavGroup, VegaGroupClick);
     this.vegaComponentUsageRuntimeMetricsSlimmer = new VegaComponentUsageRuntimeMetricsSlimmer();
-    /** label attached to the left nav group items **/
+    /** label attached to the left nav group items **
+     * @version 1.31.0
+     */
     this.label = '';
   }
   render() {
@@ -46,8 +51,11 @@ export class VegaLeftNavGroup {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
-        "text": "icon attached to the left nav group items *"
+        "tags": [{
+            "name": "version",
+            "text": "1.31.0"
+          }],
+        "text": "icon attached to the left nav group items **"
       },
       "attribute": "icon",
       "reflect": false
@@ -63,8 +71,11 @@ export class VegaLeftNavGroup {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
-        "text": "label attached to the left nav group items *"
+        "tags": [{
+            "name": "version",
+            "text": "1.31.0"
+          }],
+        "text": "label attached to the left nav group items **"
       },
       "attribute": "label",
       "reflect": false,
@@ -78,8 +89,11 @@ export class VegaLeftNavGroup {
       "cancelable": true,
       "composed": true,
       "docs": {
-        "tags": [],
-        "text": "event emitter used for notifying consumers the click event"
+        "tags": [{
+            "name": "version",
+            "text": "1.41.0"
+          }],
+        "text": "event emitter used for notifying consumers the click event *"
       },
       "complexType": {
         "original": "string",
@@ -96,6 +110,9 @@ export class VegaLeftNavGroup {
         "tags": [{
             "name": "eventSemantics",
             "text": "namespace:native"
+          }, {
+            "name": "version",
+            "text": "2.0.0"
           }],
         "text": "An event emitter used for notifying consumers the click event"
       },

package/dist/collection/components/vega-nav/vega-left-nav-link/vega-left-nav-link.js

@@ -13,6 +13,9 @@ import { createEventEmitSlimmer, } from '../../../helpers/event-manager/slimmers
 import { VegaMenuClick } from '../../../helpers/event-manager/event-id/vega-event-id';
 import { createDeprecatedPropertySlimmer, } from '../../../helpers/slimmers/deprecated-property-slimmer';
 import { VegaComponentUsageRuntimeMetricsSlimmer } from '../../../helpers/slimmers/component-usage-runtime-metrics';
+/**
+ * @version 1.31.0
+ */
 export class VegaLeftNavLink {
   constructor() {
     this.globalSlimmers = {};
@@ -21,8 +24,10 @@ export class VegaLeftNavLink {
     this.menuClickEventEmitter = createEventEmitSlimmer(VegaLeftNavLink, VegaMenuClick);
     this.deprecatedPropertySlimmer = createDeprecatedPropertySlimmer(VegaLeftNavLink, 'counterBadge.count', 'counterBadge.counter', undefined);
     this.vegaComponentUsageRuntimeMetricsSlimmer = new VegaComponentUsageRuntimeMetricsSlimmer();
-    /** boolean indicating if current link item is selected **/
-    // eslint-disable-next-line @stencil/strict-mutable
+    /** boolean indicating if current link item is selected **
+     * @version 1.31.0
+     */
+    /* eslint-disable-next-line @stencil/strict-mutable */
     this.selected = false;
   }
   render() {
@@ -49,8 +54,11 @@ export class VegaLeftNavLink {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
-        "text": "icon attached to the left nav link items *"
+        "tags": [{
+            "name": "version",
+            "text": "1.31.0"
+          }],
+        "text": "icon attached to the left nav link items **"
       },
       "attribute": "icon",
       "reflect": false
@@ -66,8 +74,11 @@ export class VegaLeftNavLink {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
-        "text": "boolean indicating if current link item is selected *"
+        "tags": [{
+            "name": "version",
+            "text": "1.31.0"
+          }],
+        "text": "boolean indicating if current link item is selected **"
       },
       "attribute": "selected",
       "reflect": true,
@@ -84,8 +95,11 @@ export class VegaLeftNavLink {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
-        "text": "url attached to the left nav link item *"
+        "tags": [{
+            "name": "version",
+            "text": "1.31.0"
+          }],
+        "text": "url attached to the left nav link item **"
       },
       "attribute": "url",
       "reflect": false
@@ -109,6 +123,9 @@ export class VegaLeftNavLink {
         "tags": [{
             "name": "deprecatedAttribute",
             "text": "[counter] The 'counter' attribute is deprecated and will be removed soon. Please use 'count' instead."
+          }, {
+            "name": "version",
+            "text": "1.31.0"
           }],
         "text": "config the counter badge for left nav link items"
       }
@@ -121,8 +138,11 @@ export class VegaLeftNavLink {
       "cancelable": true,
       "composed": true,
       "docs": {
-        "tags": [],
-        "text": "An event emitter notifying the link click event."
+        "tags": [{
+            "name": "version",
+            "text": "1.31.0"
+          }],
+        "text": "An event emitter notifying the link click event. *"
       },
       "complexType": {
         "original": "any",
@@ -139,6 +159,9 @@ export class VegaLeftNavLink {
         "tags": [{
             "name": "eventSemantics",
             "text": "namespace:native"
+          }, {
+            "name": "version",
+            "text": "2.0.0"
           }],
         "text": "An event emitter notifying the link click event."
       },

package/dist/collection/components/vega-nav/vega-left-nav-section/vega-left-nav-section.js

@@ -11,6 +11,9 @@ import { VegaLeftNavSectionRenderer } from './slimmers/renderers/vega-left-nav-s
 import { createEventEmitSlimmer, } from '../../../helpers/event-manager/slimmers/event-emit-slimmer';
 import { VegaActionClick } from '../../../helpers/event-manager/event-id/vega-event-id';
 import { VegaComponentUsageRuntimeMetricsSlimmer } from '../../../helpers/slimmers/component-usage-runtime-metrics';
+/**
+ * @version 1.31.0
+ */
 export class VegaLeftNavSection {
   constructor() {
     this.globalSlimmers = {};
@@ -47,8 +50,11 @@ export class VegaLeftNavSection {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
-        "text": "sectionHeader attached to the left nav section *"
+        "tags": [{
+            "name": "version",
+            "text": "1.31.0"
+          }],
+        "text": "sectionHeader attached to the left nav section **"
       }
     }
   }; }
@@ -59,7 +65,10 @@ export class VegaLeftNavSection {
       "cancelable": true,
       "composed": true,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "2.11.0"
+          }],
         "text": "An event emitter notifying the action click event when the action link is not configured."
       },
       "complexType": {
@@ -77,6 +86,9 @@ export class VegaLeftNavSection {
         "tags": [{
             "name": "eventSemantics",
             "text": "namespace:native"
+          }, {
+            "name": "version",
+            "text": "2.11.0"
           }],
         "text": "An event emitter notifying the action click event when the action link is not configured."
       },