@globalpayments/vega 2.24.0 → 2.25.0

package/dist/collection/components/vega-checkbox/vega-checkbox-group/vega-checkbox-group.js

@@ -17,6 +17,9 @@ import { ChildNodesEventPreventSlimmer } from '../../../helpers/event-manager/sl
 import { VegaChange } from '../../../helpers/event-manager/event-id/vega-event-id';
 import { createEventEmitSlimmer, } from '../../../helpers/event-manager/slimmers/event-emit-slimmer';
 import { VegaComponentUsageRuntimeMetricsSlimmer } from '../../../helpers/slimmers/component-usage-runtime-metrics';
+/**
+ * @version 1.0.7
+ */
 export class VegaCheckboxGroup {
   constructor() {
     this.globalSlimmers = {};
@@ -41,46 +44,65 @@ export class VegaCheckboxGroup {
      * Specifies the label or title for the checkbox group.
      *    It provides descriptive text that helps identify
      *    the purpose of the checkbox group.
+     *
+     * @version 1.3.0
      */
     this.label = '';
     /**
      * Stores the selected values of the nested checkboxes
      *    within the checkbox group.
+     *
+     * @version 1.0.7
      */
+    /* eslint-disable-next-line @stencil/strict-mutable */
     this.value = [];
     /**
      * Specifies all properties of a `vega-flex` component,
      *    accessible as an object.
+     *
+     * @version 1.3.0
      */
     this.vegaFlexProp = {};
     /**
      * Indicates if the checkbox group is disabled.
+     *
+     * @version 1.3.0
      */
     this.disabled = false;
     /**
      * Indicates whether at least one checkbox in the
      *    checkbox group must be checked to pass
      *    form validation.
+     *
+     * @version 1.3.0
      */
     this.required = false;
     /**
      * Provides a supplementary prompt message that
      *    assists users in selecting the appropriate
      *    value for the checkbox group.
+     *
+     * @version 1.3.0
      */
     this.hint = '';
     /** Specifies the validation status of the
      *    checkbox group component.
+     *
+     * @version 1.3.0
      */
-    /* eslint-disable @stencil/strict-mutable */
+    /* eslint-disable-next-line @stencil/strict-mutable */
     this.isValid = null;
     /**
      * Determines whether automatic validation should be implemented for
      *    the checkbox group upon selection.
+     *
+     * @version 2.6.0
      */
     this.autoValidation = true;
     /**
      * Defines custom validation rules for the checkbox group.
+     *
+     * @version 2.6.0
      */
     this.validationRules = [];
     /**
@@ -209,7 +231,10 @@ export class VegaCheckboxGroup {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.3.0"
+          }],
         "text": "Specifies the label or title for the checkbox group.\n   It provides descriptive text that helps identify\n   the purpose of the checkbox group."
       },
       "attribute": "label",
@@ -227,7 +252,10 @@ export class VegaCheckboxGroup {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.0.7"
+          }],
         "text": "Stores the selected values of the nested checkboxes\n   within the checkbox group."
       },
       "defaultValue": "[]"
@@ -237,7 +265,7 @@ export class VegaCheckboxGroup {
       "mutable": false,
       "complexType": {
         "original": "VegaFlexProps",
-        "resolved": "{ direction?: ResponsiveType<\"row\" | \"col\" | \"row-reverse\" | \"col-reverse\">; alignItems?: ResponsiveType<FlexAlignItemType>; gap?: ResponsiveType<\"0\" | \"size-4\" | \"size-8\" | \"size-12\" | \"size-16\" | \"size-20\" | \"size-24\" | \"size-32\" | \"size-40\" | \"size-48\" | \"size-64\" | \"size-72\" | \"size-80\" | \"size-112\" | \"size-2\">; justifyContent?: ResponsiveType<FlexJustifyContentType>; margin?: ResponsiveType<MarginType>; }",
+        "resolved": "{ direction?: ResponsiveType<\"row\" | \"col\" | \"row-reverse\" | \"col-reverse\">; alignItems?: ResponsiveType<FlexAlignItemType>; gap?: ResponsiveType<GapType>; justifyContent?: ResponsiveType<FlexJustifyContentType>; margin?: ResponsiveType<MarginType>; }",
         "references": {
           "VegaFlexProps": {
             "location": "import",
@@ -248,7 +276,10 @@ export class VegaCheckboxGroup {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.3.0"
+          }],
         "text": "Specifies all properties of a `vega-flex` component,\n   accessible as an object."
       },
       "defaultValue": "{}"
@@ -264,7 +295,10 @@ export class VegaCheckboxGroup {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.3.0"
+          }],
         "text": "Indicates if the checkbox group is disabled."
       },
       "attribute": "disabled",
@@ -282,7 +316,10 @@ export class VegaCheckboxGroup {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.3.0"
+          }],
         "text": "Indicates whether at least one checkbox in the\n   checkbox group must be checked to pass\n   form validation."
       },
       "attribute": "required",
@@ -300,7 +337,10 @@ export class VegaCheckboxGroup {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.3.0"
+          }],
         "text": "Provides a supplementary prompt message that\n   assists users in selecting the appropriate\n   value for the checkbox group."
       },
       "attribute": "hint",
@@ -318,7 +358,10 @@ export class VegaCheckboxGroup {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.3.0"
+          }],
         "text": "Specifies the validation status of the\n  checkbox group component."
       },
       "attribute": "is-valid",
@@ -336,7 +379,10 @@ export class VegaCheckboxGroup {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "2.6.0"
+          }],
         "text": "Determines whether automatic validation should be implemented for\n   the checkbox group upon selection."
       },
       "attribute": "auto-validation",
@@ -359,7 +405,10 @@ export class VegaCheckboxGroup {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "2.6.0"
+          }],
         "text": "Defines custom validation rules for the checkbox group."
       },
       "defaultValue": "[]"
@@ -372,7 +421,10 @@ export class VegaCheckboxGroup {
       "cancelable": true,
       "composed": true,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.0.10"
+          }],
         "text": "An event emitter notifying changes in the value\n  of any nested checkbox within the checkbox group,\n  whether triggered programmatically or through\n  user interaction."
       },
       "complexType": {
@@ -390,6 +442,9 @@ export class VegaCheckboxGroup {
         "tags": [{
             "name": "eventSemantics",
             "text": "namespace:native"
+          }, {
+            "name": "version",
+            "text": "2.0.0"
           }],
         "text": "An event emitter notifying changes in the value\n  of any nested checkbox within the checkbox group,\n  whether triggered programmatically or through\n  user interaction."
       },

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

@@ -18,6 +18,9 @@ import { createEventEmitSlimmer, } from '../../helpers/event-manager/slimmers/ev
 import { VegaChange } from '../../helpers/event-manager/event-id/vega-event-id';
 import { VegaCheckboxShowErrorController } from './slimmers/controllers/vega-checkbox-show-error-controller';
 import { VegaComponentUsageRuntimeMetricsSlimmer } from '../../helpers/slimmers/component-usage-runtime-metrics';
+/**
+ * @version 1.0.7
+ */
 export class VegaCheckbox {
   constructor() {
     this.globalSlimmers = {};
@@ -49,6 +52,8 @@ export class VegaCheckbox {
      *
      * Refer to the `value` property for detailed information on
      *    how to use this property during form validation.
+     *
+     * @version 1.10.0
      */
     this.identifier = '';
     /**
@@ -63,31 +68,44 @@ export class VegaCheckbox {
      * If the `identifier` property is not set, the `value` property behaves
      *    as a boolean and returns `true` when the checkbox is checked,
      *    and `false` when it is unchecked.
+     *
+     * @version 1.0.7
      */
+    /* eslint-disable-next-line @stencil/strict-mutable */
     this.value = this.identifier !== '' ? '' : false;
     /**
      * Specifies whether the checkbox should be pre-checked.
      *
      * Use the `value` property to retrieve the current status of the checkbox.
+     *
+     * @version 1.0.7
      */
     this.checked = false;
     /**
      * Specifies whether the checkbox element is disabled.
+     *
+     * @version 1.3.0
      */
     this.disabled = false;
     /**
      * Specifies the size of the checkbox.
+     *
+     * @version 1.3.0
      */
     this.size = 'default';
     /**
      * Specifies whether the checkbox must be checked
      *    to pass form validation.
+     *
+     * @version 1.3.0
      */
     this.required = false;
     /**
      * Specifies the validation status of the checkbox component.
+     *
+     * @version 1.10.0
      */
-    /* eslint-disable @stencil/strict-mutable */
+    /* eslint-disable-next-line @stencil/strict-mutable */
     this.isValid = null;
     /**
      * The below method is e2e-test covered in
@@ -127,6 +145,8 @@ export class VegaCheckbox {
    * Invoke this method to set the value of the checkbox.
    *
    * It is recommended to use this method instead of directly modifying the `value` property.
+   *
+   * @version 1.16.0
    */
   async setValue(value) {
     this.checked = this.identifier ? value === this.identifier : value === true;
@@ -230,7 +250,10 @@ export class VegaCheckbox {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.10.0"
+          }],
         "text": "Sets a unique identifier for the checkbox.\n\nRefer to the `value` property for detailed information on\n   how to use this property during form validation."
       },
       "attribute": "identifier",
@@ -248,7 +271,10 @@ export class VegaCheckbox {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.0.7"
+          }],
         "text": "Determines the value that is associated with the checkbox\n   when it is checked or unchecked.\n\nWhen the `identifier` property is set, the `value` property will\n   return the value of the `identifier` when the checkbox is checked.\n   When the checkbox is unchecked, the `value` property will\n   return an empty string ''.\n\nIf the `identifier` property is not set, the `value` property behaves\n   as a boolean and returns `true` when the checkbox is checked,\n   and `false` when it is unchecked."
       },
       "attribute": "value",
@@ -266,7 +292,10 @@ export class VegaCheckbox {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.0.7"
+          }],
         "text": "Specifies whether the checkbox should be pre-checked.\n\nUse the `value` property to retrieve the current status of the checkbox."
       },
       "attribute": "checked",
@@ -284,7 +313,10 @@ export class VegaCheckbox {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.3.0"
+          }],
         "text": "Specifies whether the checkbox element is disabled."
       },
       "attribute": "disabled",
@@ -302,7 +334,10 @@ export class VegaCheckbox {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.3.0"
+          }],
         "text": "Specifies the size of the checkbox."
       },
       "attribute": "size",
@@ -320,7 +355,10 @@ export class VegaCheckbox {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.3.0"
+          }],
         "text": "Specifies whether the checkbox must be checked\n   to pass form validation."
       },
       "attribute": "required",
@@ -338,7 +376,10 @@ export class VegaCheckbox {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.10.0"
+          }],
         "text": "Specifies the validation status of the checkbox component."
       },
       "attribute": "is-valid",
@@ -357,7 +398,10 @@ export class VegaCheckbox {
       "cancelable": true,
       "composed": true,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.0.10"
+          }],
         "text": "An event emitter notifying changes in the value of the checkbox,\n   whether triggered programmatically or through user interaction."
       },
       "complexType": {
@@ -375,6 +419,9 @@ export class VegaCheckbox {
         "tags": [{
             "name": "eventSemantics",
             "text": "namespace:native"
+          }, {
+            "name": "version",
+            "text": "2.0.0"
           }],
         "text": "An event emitter notifying changes in the value of the checkbox,\n   whether triggered programmatically or through user interaction."
       },
@@ -401,7 +448,10 @@ export class VegaCheckbox {
       },
       "docs": {
         "text": "Invoke this method to set the value of the checkbox.\n\nIt is recommended to use this method instead of directly modifying the `value` property.",
-        "tags": []
+        "tags": [{
+            "name": "version",
+            "text": "1.16.0"
+          }]
       }
     }
   }; }

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

@@ -18,6 +18,9 @@ import { VegaClick, VegaClose } from '../../helpers/event-manager/event-id/vega-
 import { ChildNodesEventPreventSlimmer } from '../../helpers/event-manager/slimmers/child-nodes-event-prevent-slimmer';
 import { VegaComponentUsageRuntimeMetricsSlimmer } from '../../helpers/slimmers/component-usage-runtime-metrics';
 import { VegaChipRuntimeMetricsPayloadDefinition } from '../../constants/runtime-metrics-payload-definition/vega-chip/runtime-metrics-payload-definition';
+/**
+ * @version 1.11.0
+ */
 export class VegaChip {
   constructor() {
     this.globalSlimmers = {};
@@ -36,18 +39,26 @@ export class VegaChip {
      *
      * It provides descriptive text that helps identify
      *    the purpose or category of the chip.
+     *
+     * @version 1.11.0
      */
     this.text = '';
     /**
      * Specifies whether the chip is clickable.
+     *
+     * @version 1.11.0
      */
     this.clickable = false;
     /**
      * Determines the rendering style for the chip.
+     *
+     * @version 1.11.0
      */
     this.variant = 'filled-background';
     /**
      * Specifies the size of the chip.
+     *
+     * @version 1.11.0
      */
     this.size = 'default';
     /**
@@ -55,15 +66,21 @@ export class VegaChip {
      *
      * This property is only applicable when using the `filled-background` variant,
      *    which is a specific style option for the chip.
+     *
+     * @version 1.11.0
      */
     this.bgColor = 'bg-chip';
     /**
      * Specifies the color of the text displayed within the chip.
+     *
+     * @version 1.11.0
      */
     this.textColor = 'text-primary';
     /**
      * Specifies the color of the status dot when
      *    the chip's type is set to `status`.
+     *
+     * @version 1.11.0
      */
     this.statusColor = 'bg-status-info';
     /**
@@ -79,15 +96,21 @@ export class VegaChip {
      *    the chip allows for more flexibility in positioning the icon.
      *    You can choose to have the icon as a prefix or a suffix to the label text.
      *    This type is commonly used when the chip represents a label or category.
+     *
+     * @version 1.11.0
      */
     this.chipType = 'label';
     /**
      * Controls the visibility of a close button within the chip.
+     *
+     * @version 1.11.0
      */
     this.showCloseIcon = false;
     /**
      * Specifies the placement or alignment of the icon within
      *    the chip in relation to the chip's text.
+     *
+     * @version 1.11.0
      */
     this.iconAlign = 'left';
     this.closeChip = (e) => {
@@ -214,7 +237,10 @@ export class VegaChip {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.11.0"
+          }],
         "text": "Specifies the label or title for the chip.\n\nIt provides descriptive text that helps identify\n   the purpose or category of the chip."
       },
       "attribute": "text",
@@ -232,7 +258,10 @@ export class VegaChip {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.11.0"
+          }],
         "text": "Specifies whether the chip is clickable."
       },
       "attribute": "clickable",
@@ -255,7 +284,10 @@ export class VegaChip {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.11.0"
+          }],
         "text": "Determines the rendering style for the chip."
       },
       "attribute": "variant",
@@ -282,7 +314,10 @@ export class VegaChip {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.11.0"
+          }],
         "text": "Specifies the size of the chip."
       },
       "attribute": "size",
@@ -305,7 +340,10 @@ export class VegaChip {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.11.0"
+          }],
         "text": "Specifies the background color of the chip.\n\nThis property is only applicable when using the `filled-background` variant,\n   which is a specific style option for the chip."
       },
       "attribute": "bg-color",
@@ -328,7 +366,10 @@ export class VegaChip {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.11.0"
+          }],
         "text": "Specifies the color of the text displayed within the chip."
       },
       "attribute": "text-color",
@@ -351,7 +392,10 @@ export class VegaChip {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.11.0"
+          }],
         "text": "Specifies the color of the status dot when\n   the chip's type is set to `status`."
       },
       "attribute": "status-color",
@@ -374,7 +418,10 @@ export class VegaChip {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.11.0"
+          }],
         "text": "Specifies the type of the chip,\n   determining its visual appearance and behavior.\n\nThere are two available options: `status` and `label`:\n- When `chipType` is set to `status`, the chip will display a dot as a prefix.\n   This style is commonly used to indicate a specific status\n   or state associated with the chip.\n   The `icon` and `iconAlign` properties are disabled in this mode.\n- On the other hand, when `chipType` is set to `label`,\n   the chip allows for more flexibility in positioning the icon.\n   You can choose to have the icon as a prefix or a suffix to the label text.\n   This type is commonly used when the chip represents a label or category."
       },
       "attribute": "chip-type",
@@ -392,7 +439,10 @@ export class VegaChip {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.11.0"
+          }],
         "text": "Controls the visibility of a close button within the chip."
       },
       "attribute": "show-close-icon",
@@ -410,7 +460,10 @@ export class VegaChip {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.11.0"
+          }],
         "text": "Displays an icon in the chip. This property is applicable only when\n   the chip's type is set to `label`."
       },
       "attribute": "icon",
@@ -432,7 +485,10 @@ export class VegaChip {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.11.0"
+          }],
         "text": "Specifies the placement or alignment of the icon within\n   the chip in relation to the chip's text."
       },
       "attribute": "icon-align",
@@ -451,7 +507,10 @@ export class VegaChip {
       "cancelable": true,
       "composed": true,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.11.0"
+          }],
         "text": "An event emitter notifying the click event of the close button of the chip.\n\nThis event is only dispatched when the `showCloseIcon` property is set to `true`."
       },
       "complexType": {
@@ -469,6 +528,9 @@ export class VegaChip {
         "tags": [{
             "name": "eventSemantics",
             "text": "namespace:native"
+          }, {
+            "name": "version",
+            "text": "2.0.0"
           }],
         "text": "An event emitter notifying the click event of the close button of the chip."
       },
@@ -484,7 +546,10 @@ export class VegaChip {
       "cancelable": true,
       "composed": true,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.11.0"
+          }],
         "text": "An event emitter notifying the click event of the chip.\n\nThis event is only dispatched when the `clickable` property is set to `true`."
       },
       "complexType": {
@@ -502,6 +567,9 @@ export class VegaChip {
         "tags": [{
             "name": "eventSemantics",
             "text": "namespace:native"
+          }, {
+            "name": "version",
+            "text": "2.0.0"
           }],
         "text": "An event emitter notifying the click event of the chip."
       },