@globalpayments/vega 2.23.0 → 2.24.2

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

@@ -13,6 +13,9 @@ import { VegaBoxStateStylesController } from './slimmers/controllers/vega-box-st
 import responsiveFormatFacade from '../../helpers/formatter/responsive-map-formatter/responsive-format-facade';
 import { PageResizeObserverSlimmer } from '../../helpers/slimmers/page-resize-observer-slimmer';
 import { VegaComponentUsageRuntimeMetricsSlimmer } from '../../helpers/slimmers/component-usage-runtime-metrics';
+/**
+ * @version 1.27.0
+ */
 export class VegaBox {
   constructor() {
     this.globalSlimmers = {};
@@ -97,7 +100,10 @@ export class VegaBox {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.27.0"
+          }],
         "text": "Determines the spacing between the content and the edges of the box.\n   It can be set as a spacing value, such as `size-16` or `size-24`,\n   to apply the same padding on all sides.\n\nAlternatively, you can set the padding as a responsive map,\n   allowing you to define different padding values for different breakpoints.\n   The responsive map should follow the structure\n   `{default: 'size-12', L: { top: 'size-24', bottom: 'size-24'}}`.\n\nNote that the `default` value is required when using a responsive map\n   to provide a fallback padding value for breakpoints\n   that are not explicitly defined."
       },
       "attribute": "padding",
@@ -123,7 +129,10 @@ export class VegaBox {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.27.0"
+          }],
         "text": "Defines the spacing around the box.\n   You can set it as a single spacing value,\n   such as `size-16` or `size-24`, which will apply\n   the same margin on all sides of the box.\n\nAlternatively, you can set the padding as a responsive map,\n   allowing you to define different margin values for different breakpoints.\n   The responsive map should follow the structure\n   `{default: 'size-12', L: { top: 'size-24', bottom: 'size-24'}}`.\n\nNote that the `default` value is required when using a responsive map\n   to provide a fallback margin value for breakpoints\n   that are not explicitly defined."
       },
       "attribute": "margin",
@@ -149,7 +158,10 @@ export class VegaBox {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.38.0"
+          }],
         "text": "Defines the display behavior of the box, allowing you to choose from\n   standard display options like `block` and `none`."
       },
       "attribute": "display",
@@ -179,7 +191,10 @@ export class VegaBox {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "2.0.0"
+          }],
         "text": "Defines the border of the box.\n   It accepts a string value representing a valid\n   border token."
       },
       "attribute": "border",
@@ -201,8 +216,11 @@ export class VegaBox {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
-        "text": "Specifies the line style of the box border."
+        "tags": [{
+            "name": "version",
+            "text": "2.7.0"
+          }],
+        "text": "Specifies the line style of the box border. *"
       },
       "attribute": "border-style",
       "reflect": false
@@ -227,7 +245,10 @@ export class VegaBox {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "2.0.0"
+          }],
         "text": "Defines the box shadow of the box.\n   It accepts a string value representing a valid\n   box shadow token."
       },
       "attribute": "shadow",
@@ -257,7 +278,10 @@ export class VegaBox {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "2.0.0"
+          }],
         "text": "Defines the border color of the box.\n   It accepts a string value representing a valid\n   border color token."
       },
       "attribute": "border-color",
@@ -287,7 +311,10 @@ export class VegaBox {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "2.0.0"
+          }],
         "text": "Defines the background color of the box.\n   It accepts a string value representing a valid\n   background color token."
       },
       "attribute": "background-color",
@@ -313,7 +340,10 @@ export class VegaBox {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "2.0.0"
+          }],
         "text": "Specifies the width of the box.\nIt accepts values in numeric, string and spacing token formats.\nFor numeric values, use a number to indicate the width\n   in pixels, e.g., 100 will be translated to 100px.\nFor string values, you can use CSS units like '%' or 'calc' expressions.\n   For example, '100%' and 'calc(100vw - 20px)' which allows for more complex calculations to\n   determine the width.\nFor spacing tokens, you can set 'size-2', 'size-16' and etc. Please refer to https://vega.hlprd.com/tokens/spacing to check the full list of spacing tokens."
       },
       "attribute": "width",
@@ -339,7 +369,10 @@ export class VegaBox {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "2.0.0"
+          }],
         "text": "Specifies the height of the box.\nIt accepts values in numeric, string and spacing token formats.\nFor numeric values, use a number to indicate the height\n   in pixels, e.g., 100 will be translated to 100px.\nFor string values, you can use CSS units like '%' or 'calc' expressions.\n   For example, '100%' and 'calc(100vh - 20px)' which allows for more complex calculations to\n   determine the height.\nFor spacing tokens, you can set 'size-2', 'size-16' and etc. Please refer to https://vega.hlprd.com/tokens/spacing to check the full list of spacing tokens."
       },
       "attribute": "height",
@@ -365,7 +398,10 @@ export class VegaBox {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "2.7.0"
+          }],
         "text": "Specifies the minimum height of the box.\nIt accepts values in numeric, string and spacing token formats.\nNumeric values represent minimum heights in pixels\n   (e.g., 100 translates to 100px).\nString values allow the use of CSS units such as '%'\n   or keyword values like 'max-content'\n   (e.g., '100%' or 'max-content').\nSpacing tokens like 'size-2' or 'size-16' can also be used.\n   Please refer to https://vega.hlprd.com/tokens/spacing\n   to check the full list of spacing tokens."
       },
       "attribute": "min-height",
@@ -391,7 +427,10 @@ export class VegaBox {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "2.7.0"
+          }],
         "text": "Specifies the maximum height of the box.\nIt accepts values in numeric, string and spacing token formats.\nNumeric values represent maximum heights in pixels\n   (e.g., 100 translates to 100px).\nString values allow the use of CSS units such as '%'\n   or keyword values like 'min-content'\n   (e.g., '100%' or 'min-content').\nSpacing tokens like 'size-2' or 'size-16' can also be used.\n   Please refer to https://vega.hlprd.com/tokens/spacing\n   to check the full list of spacing tokens."
       },
       "attribute": "max-height",
@@ -413,7 +452,10 @@ export class VegaBox {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "2.0.0"
+          }],
         "text": "Defines the custom class name of the box."
       },
       "attribute": "responsive-class",
@@ -439,7 +481,10 @@ export class VegaBox {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "2.0.0"
+          }],
         "text": "Defines the corner of the box.\n   It accepts a string value representing a valid\n   border radius token."
       },
       "attribute": "corners",
@@ -465,7 +510,10 @@ export class VegaBox {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "2.3.0"
+          }],
         "text": "Specifies the base size of the box."
       },
       "attribute": "flex-basis",
@@ -491,7 +539,10 @@ export class VegaBox {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "2.3.0"
+          }],
         "text": "Specifies how the box is grow."
       },
       "attribute": "flex-grow",
@@ -517,7 +568,10 @@ export class VegaBox {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "2.3.0"
+          }],
         "text": "Specifies how much the box shrinks."
       },
       "attribute": "flex-shrink",
@@ -543,7 +597,10 @@ export class VegaBox {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "2.3.0"
+          }],
         "text": "Specifies the display order of the box."
       },
       "attribute": "order",
@@ -569,7 +626,10 @@ export class VegaBox {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "2.3.0"
+          }],
         "text": "Specifies how the box adjusts its size, growth, and alignment within a flex container."
       },
       "attribute": "flex",
@@ -595,7 +655,10 @@ export class VegaBox {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "2.3.0"
+          }],
         "text": "Specifies how the box aligns itself within its container."
       },
       "attribute": "align-self",
@@ -621,7 +684,10 @@ export class VegaBox {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "2.3.0"
+          }],
         "text": "Specifies how a single box justifies its content along the main axis within its container."
       },
       "attribute": "justify-self",
@@ -647,7 +713,10 @@ export class VegaBox {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "2.5.0"
+          }],
         "text": "Determines the placement of the item within the grid along the horizontal axis."
       },
       "attribute": "grid-column",
@@ -673,7 +742,10 @@ export class VegaBox {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "2.5.0"
+          }],
         "text": "Determines the placement of the item within the grid along the vertical axis."
       },
       "attribute": "grid-row",
@@ -699,7 +771,10 @@ export class VegaBox {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "2.5.0"
+          }],
         "text": "Defines the area within the grid occupied by the item. It accepts CSS values and can be set as ResponsiveType."
       },
       "attribute": "grid-area",

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

@@ -15,6 +15,9 @@ import { ChildNodesEventPreventSlimmer } from '../../helpers/event-manager/slimm
 import { createEventEmitSlimmer, } from '../../helpers/event-manager/slimmers/event-emit-slimmer';
 import { VegaClick } from '../../helpers/event-manager/event-id/vega-event-id';
 import { VegaComponentUsageRuntimeMetricsSlimmer } from '../../helpers/slimmers/component-usage-runtime-metrics';
+/**
+ * @version 1.41.0
+ */
 export class VegaBreadcrumb {
   constructor() {
     this.globalSlimmers = {};
@@ -35,10 +38,14 @@ export class VegaBreadcrumb {
      * If you set this value to `none`, all items will remain expanded.
   
      * The minimum allowed value for this property is 4.
+     *
+     * @version 1.41.0
      */
     this.maxItems = 4;
     /**
      * Represents the individual elements within the `vega-breadcrumb` component.
+     *
+     * @version 1.41.0
      */
     this.items = [];
   }
@@ -70,7 +77,10 @@ export class VegaBreadcrumb {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.41.0"
+          }],
         "text": "Determines the maximum number of visible items in the `vega-breadcrumb` component,\n   primarily in desktop mode.\n\nWhen the number of items exceeds this limit, the component automatically\n   collapses the center items, rendering only the first and last items visible.\n\nIf you set this value to `none`, all items will remain expanded.\n\nThe minimum allowed value for this property is 4."
       },
       "attribute": "max-items",
@@ -93,7 +103,10 @@ export class VegaBreadcrumb {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.41.0"
+          }],
         "text": "Represents the individual elements within the `vega-breadcrumb` component."
       },
       "defaultValue": "[]"
@@ -106,7 +119,10 @@ export class VegaBreadcrumb {
       "cancelable": true,
       "composed": true,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.41.0"
+          }],
         "text": "An event emitter notifying that a breadcrumb item has been clicked."
       },
       "complexType": {
@@ -129,6 +145,9 @@ export class VegaBreadcrumb {
         "tags": [{
             "name": "eventSemantics",
             "text": "namespace:native"
+          }, {
+            "name": "version",
+            "text": "2.0.0"
           }],
         "text": "An event emitter notifying that a breadcrumb item has been clicked."
       },

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

@@ -17,6 +17,10 @@ import { VegaClick } from '../../helpers/event-manager/event-id/vega-event-id';
 import { ChildNodesEventPreventSlimmer } from '../../helpers/event-manager/slimmers/child-nodes-event-prevent-slimmer';
 import { VegaComponentUsageRuntimeMetricsSlimmer } from '../../helpers/slimmers/component-usage-runtime-metrics';
 import { VegaButtonLoadingRenderer } from './slimmers/renderers/vega-button-loading-renderer';
+import responsiveFormatFacade from '../../helpers/formatter/responsive-map-formatter/responsive-format-facade';
+/**
+ * @version 1.0.0
+ */
 export class VegaButton {
   constructor() {
     this.globalSlimmers = {};
@@ -39,45 +43,64 @@ export class VegaButton {
     this.currentBreakpoint = getCurrentBreakpoint();
     /**
      * Specifies the size of the button.
+     *
+     * @version 1.0.0
      */
     this.size = 'default';
     /**
      * Specifies the visual style and prominence of the button.
      *
      * It determines how the button will be presented to the user.
+     *
+     * @version 1.0.0
      */
     this.variant = 'primary';
     /**
      * Specifies the placement of the icon in relation to the button's label.
+     *
+     * @version 1.3.0
      */
     this.iconAlign = 'left';
     /**
      * Specifies the text displayed on the button.
+     *
+     * @version 1.0.3
      */
+    /* eslint-disable-next-line @stencil/strict-mutable */
     this.label = null;
     /**
      * Specifies whether the button element is disabled.
+     *
+     * @version 1.0.3
      */
     this.disabled = false;
     /**
      * Indicates the danger status of the button,
      *    typically used for destructive actions.
+     *
+     * @version 1.3.0
      */
     this.danger = false;
     /**
      * Specifies whether the button should span the
      *    full width of its parent element.
+     *
+     * @version 1.3.0
      */
     this.block = false;
     /**
      * Specifies the type of button and its behavior in relation to
      *    form submission and data reset.
+     *
+     * @version 1.0.3
      */
     this.type = 'button';
     /**
      * Specifies whether the button is in a loading state. When `true`,
      *     the button is disabled and an indeterminate loading indicator
      *     is displayed within the button.
+     *
+     * @version 2.17.0
      */
     this.loading = false;
     this.handleClick = (e) => {
@@ -99,7 +122,7 @@ export class VegaButton {
     this.host.innerHTML = '';
   }
   render() {
-    return sanitizeVegaComponent(h(Host, { class: { 'vega-button-block': this.block } },
+    return sanitizeVegaComponent(h(Host, { class: { 'vega-button-block': this.isBlockStyleButton() } },
       h("button", { type: this.type, "aria-label": this.label || 'No label defined', class: {
           [`vega-button-size-${ResponsiveFormatFacade.formatCustom(this.size)}`]: true,
           [`vega-button-variant-${this.variant}`]: true,
@@ -137,6 +160,14 @@ export class VegaButton {
   isDisabledButton() {
     return this.disabled || this.loading;
   }
+  /**
+   * Returns a boolean value based on the formatting of a block using a responsive format facade.
+   *
+   * @returns {boolean} A boolean value.
+   */
+  isBlockStyleButton() {
+    return responsiveFormatFacade.formatCustom(this.block);
+  }
   static get is() { return "vega-button"; }
   static get encapsulation() { return "shadow"; }
   static get originalStyleUrls() { return {
@@ -166,7 +197,10 @@ export class VegaButton {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.0.0"
+          }],
         "text": "Specifies the size of the button."
       },
       "attribute": "size",
@@ -189,7 +223,10 @@ export class VegaButton {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.0.0"
+          }],
         "text": "Specifies the visual style and prominence of the button.\n\nIt determines how the button will be presented to the user."
       },
       "attribute": "variant",
@@ -207,7 +244,10 @@ export class VegaButton {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.0.3"
+          }],
         "text": "Specifies the icon to be displayed on the button,\n   which can be selected from a list of predefined icon tokens\n   or specified using a Font Awesome class."
       },
       "attribute": "icon",
@@ -229,7 +269,10 @@ export class VegaButton {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.3.0"
+          }],
         "text": "Specifies the placement of the icon in relation to the button's label."
       },
       "attribute": "icon-align",
@@ -247,7 +290,10 @@ export class VegaButton {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.0.3"
+          }],
         "text": "Specifies the text displayed on the button."
       },
       "attribute": "label",
@@ -265,7 +311,10 @@ export class VegaButton {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.0.3"
+          }],
         "text": "Specifies whether the button element is disabled."
       },
       "attribute": "disabled",
@@ -283,7 +332,10 @@ export class VegaButton {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.3.0"
+          }],
         "text": "Indicates the danger status of the button,\n   typically used for destructive actions."
       },
       "attribute": "danger",
@@ -294,14 +346,22 @@ export class VegaButton {
       "type": "boolean",
       "mutable": false,
       "complexType": {
-        "original": "boolean",
-        "resolved": "boolean",
-        "references": {}
+        "original": "ResponsiveType<boolean>",
+        "resolved": "boolean | { S?: boolean; M?: boolean; L?: boolean; XL?: boolean; default?: boolean; }",
+        "references": {
+          "ResponsiveType": {
+            "location": "import",
+            "path": "../../types/ui.type"
+          }
+        }
       },
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.3.0"
+          }],
         "text": "Specifies whether the button should span the\n   full width of its parent element."
       },
       "attribute": "block",
@@ -324,7 +384,10 @@ export class VegaButton {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.0.3"
+          }],
         "text": "Specifies the type of button and its behavior in relation to\n   form submission and data reset."
       },
       "attribute": "type",
@@ -342,7 +405,10 @@ export class VegaButton {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "2.17.0"
+          }],
         "text": "Specifies whether the button is in a loading state. When `true`,\n    the button is disabled and an indeterminate loading indicator\n    is displayed within the button."
       },
       "attribute": "loading",
@@ -360,7 +426,10 @@ export class VegaButton {
       "cancelable": true,
       "composed": true,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.0.11"
+          }],
         "text": "An event emitter notifying the click event of the button."
       },
       "complexType": {
@@ -378,6 +447,9 @@ export class VegaButton {
         "tags": [{
             "name": "eventSemantics",
             "text": "namespace:native"
+          }, {
+            "name": "version",
+            "text": "2.0.0"
           }],
         "text": "An event emitter notifying the click event of the button."
       },