@globalpayments/vega 2.24.0 → 2.24.2

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."
       },

package/dist/collection/components/vega-color-picker/vega-color-picker.js

@@ -17,6 +17,9 @@ import ChangeManager from '../../helpers/change-manager/change-manager';
 import { VegaChange } from '../../helpers/event-manager/event-id/vega-event-id';
 import { VegaComponentUsageRuntimeMetricsSlimmer } from '../../helpers/slimmers/component-usage-runtime-metrics';
 import { VegaColorPickerRuntimeMetricsPayloadDefinition } from '../../constants/runtime-metrics-payload-definition/vega-color-picker/runtime-metrics-payload-definition';
+/**
+ * @version 1.13.0
+ */
 export class VegaColorPicker {
   constructor() {
     this.globalSlimmers = {};
@@ -38,20 +41,29 @@ export class VegaColorPicker {
     /**
      * Specifies the initial or preset color value of the color picker.
      *    It is represented as a hexadecimal string.
+     *
+     * @version 1.13.0
      */
+    /* eslint-disable-next-line @stencil/strict-mutable */
     this.value = '';
     /**
      * Displays a supplementary prompt message that assists users
      *    in understanding the expected value for the color picker.
+     *
+     * @version 1.13.0
      */
     this.hint = '';
     /**
      * Specifies whether the color picker element is disabled.
+     *
+     * @version 1.13.0
      */
     this.disabled = false;
     /**
      * Specifies whether a color must be selected for
      *    the color picker to pass form validation.
+     *
+     * @version 1.13.0
      */
     this.required = false;
     /**
@@ -59,26 +71,36 @@ export class VegaColorPicker {
      *
      * It provides descriptive text that helps identify
      *    the purpose or content expected in the color picker.
+     *
+     * @version 1.13.0
      */
     this.label = '';
     /**
      * Specifies the validation status of the color picker component.
+     *
+     * @version 1.13.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 color picker when a color is selected.
+     *
+     * @version 1.13.0
      */
     this.autoValidation = true;
     /**
      * Specifies custom validation rules for the color picker.
+     *
+     * @version 1.13.0
      */
     this.validationRules = [];
     /**
      * Defines custom color options for the color picker.
      *
      * It should be an array of hexadecimal strings representing different colors.
+     *
+     * @version 1.13.0
      */
     this.colors = [
       '#73E6DC',
@@ -177,7 +199,10 @@ export class VegaColorPicker {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.13.0"
+          }],
         "text": "Specifies the initial or preset color value of the color picker.\n   It is represented as a hexadecimal string."
       },
       "attribute": "value",
@@ -195,7 +220,10 @@ export class VegaColorPicker {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.13.0"
+          }],
         "text": "Displays a supplementary prompt message that assists users\n   in understanding the expected value for the color picker."
       },
       "attribute": "hint",
@@ -213,7 +241,10 @@ export class VegaColorPicker {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.13.0"
+          }],
         "text": "Specifies whether the color picker element is disabled."
       },
       "attribute": "disabled",
@@ -231,7 +262,10 @@ export class VegaColorPicker {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.13.0"
+          }],
         "text": "Specifies whether a color must be selected for\n   the color picker to pass form validation."
       },
       "attribute": "required",
@@ -249,7 +283,10 @@ export class VegaColorPicker {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.13.0"
+          }],
         "text": "Specifies the label or title for the color picker.\n\nIt provides descriptive text that helps identify\n   the purpose or content expected in the color picker."
       },
       "attribute": "label",
@@ -267,7 +304,10 @@ export class VegaColorPicker {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.13.0"
+          }],
         "text": "Specifies the validation status of the color picker component."
       },
       "attribute": "is-valid",
@@ -285,7 +325,10 @@ export class VegaColorPicker {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.13.0"
+          }],
         "text": "Determines whether automatic validation should be implemented\n for the color picker when a color is selected."
       },
       "attribute": "auto-validation",
@@ -308,7 +351,10 @@ export class VegaColorPicker {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.13.0"
+          }],
         "text": "Specifies custom validation rules for the color picker."
       },
       "defaultValue": "[]"
@@ -324,7 +370,10 @@ export class VegaColorPicker {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.13.0"
+          }],
         "text": "Defines custom color options for the color picker.\n\nIt should be an array of hexadecimal strings representing different colors."
       },
       "defaultValue": "[\n\t\t'#73E6DC',\n\t\t'#806BFF',\n\t\t'#FFDC83',\n\t\t'#FF9571',\n\t\t'#00BBFF',\n\t\t'#FF82C9',\n\t\t'#259F9F',\n\t\t'#563D82',\n\t]"
@@ -337,7 +386,10 @@ export class VegaColorPicker {
       "cancelable": true,
       "composed": true,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.13.0"
+          }],
         "text": "An event emitter notifying changes in the value of the color picker,\n   whether triggered programmatically or through user interaction."
       },
       "complexType": {
@@ -355,6 +407,9 @@ export class VegaColorPicker {
         "tags": [{
             "name": "eventSemantics",
             "text": "namespace:native"
+          }, {
+            "name": "version",
+            "text": "2.0.0"
           }],
         "text": "An event emitter notifying changes in the value of the color picker,\n   whether triggered programmatically or through user interaction."
       },