@globalpayments/vega 2.24.0 → 2.24.2

package/dist/collection/components/vega-image-uploader/vega-image-uploader.js

@@ -26,6 +26,9 @@ import { createEventEmitSlimmer, } from '../../helpers/event-manager/slimmers/ev
 import { VegaComponentUsageRuntimeMetricsSlimmer } from '../../helpers/slimmers/component-usage-runtime-metrics';
 import { VegaImageUploaderRuntimeMetricsPayloadDefinition } from '../../constants/runtime-metrics-payload-definition/vega-image-uploader/runtime-metrics-payload-definition';
 const IMAGE_FILE_TYPES = ['jpg', 'png', 'jpeg'];
+/**
+ * @version 1.14.0
+ */
 export class VegaImageUploader {
   constructor() {
     this.globalSlimmers = {};
@@ -62,65 +65,93 @@ export class VegaImageUploader {
      * Determines the visual content that is initially displayed in
      *    the image uploader component, thereby providing a preview of
      *    the uploaded image or a default placeholder.
+     *
+     * @version 1.14.0
      */
     /* eslint-disable-next-line @stencil/strict-mutable */
     this.value = null;
     /**
      * Specifies the allowed file types for upload.
+     *
+     * @version 1.14.0
      */
     this.accept = IMAGE_FILE_TYPES.map((type) => `.${type}`).join(',');
     /**
      * Determines whether to show the preview button.
+     *
+     * @version 1.14.0
      */
     this.showPreviewButton = true;
     /**
      * Determines whether to show the remove button.
+     *
+     * @version 1.14.0
      */
     this.showRemoveButton = true;
     /**
      * Determines whether to show the replace button.
+     *
+     * @version 1.39.2
      */
     this.showReplaceButton = true;
     /**
      * Specifies whether the Image Uploader field is disabled.
+     *
+     * @version 1.14.0
      */
     this.disabled = false;
     /**
      * Specifies whether uploading an image is mandatory.
+     *
+     * @version 1.14.0
      */
     this.required = false;
     /**
      * Specifies the validation status.
+     *
+     * @version 1.14.0
      */
     /* eslint-disable-next-line @stencil/strict-mutable */
     this.isValid = null;
     /**
      * Determines whether automatic validation should be
      *    implemented for image uploads.
+     *
+     * @version 1.14.0
      */
     this.autoValidation = true;
     /**
      * Specifies custom validation rules for image uploads.
+     *
+     * @version 1.14.0
      */
     this.validationRules = [];
     /**
      * Specifies the label or title for the image uploader.
      *    It provides descriptive text that helps identify
      *    the purpose of the image uploader.
+     *
+     * @version 2.5.0
      */
     this.label = '';
     /**
      * Specifies the action title for the image uploader.
      *    This property provides descriptive text that identifies
      *    the intended action or function of the image uploader.
+     *
+     * @version 2.9.0
      */
     this.actionTitle = 'Upload';
     /**
      * Defines the width of the image uploader field.
+     *
+     * @version 2.9.0
      */
     this.width = 120;
     /**
      * Defines the height of the image uploader field.
+     *
+     * @version 2.9.0
      */
     this.height = 120;
   }
@@ -136,6 +167,8 @@ export class VegaImageUploader {
   /**
    * Invoke this method to retrieve the image preview URL for
    *    the current selection in the `vega-image-uploader` component.
+   *
+   * @version 1.45.0
    */
   async getContentURL(file) {
     return methodPlaceholder(file);
@@ -168,7 +201,10 @@ export class VegaImageUploader {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.14.0"
+          }],
         "text": "Determines the visual content that is initially displayed in\n   the image uploader component, thereby providing a preview of\n   the uploaded image or a default placeholder."
       },
       "defaultValue": "null"
@@ -184,7 +220,10 @@ export class VegaImageUploader {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.14.0"
+          }],
         "text": "Specifies the allowed file types for upload."
       },
       "attribute": "accept",
@@ -207,7 +246,10 @@ export class VegaImageUploader {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.14.0"
+          }],
         "text": "Controls the display of the upload status (`uploading`, `done`).\n   If not set, the status remains invisible."
       },
       "attribute": "status",
@@ -224,7 +266,10 @@ export class VegaImageUploader {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.14.0"
+          }],
         "text": "Determines whether to show the preview button."
       },
       "attribute": "show-preview-button",
@@ -242,7 +287,10 @@ export class VegaImageUploader {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.14.0"
+          }],
         "text": "Determines whether to show the remove button."
       },
       "attribute": "show-remove-button",
@@ -260,7 +308,10 @@ export class VegaImageUploader {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.39.2"
+          }],
         "text": "Determines whether to show the replace button."
       },
       "attribute": "show-replace-button",
@@ -278,7 +329,10 @@ export class VegaImageUploader {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.14.0"
+          }],
         "text": "Specifies whether the Image Uploader field is disabled."
       },
       "attribute": "disabled",
@@ -296,7 +350,10 @@ export class VegaImageUploader {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.14.0"
+          }],
         "text": "Specifies whether uploading an image is mandatory."
       },
       "attribute": "required",
@@ -314,7 +371,10 @@ export class VegaImageUploader {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.14.0"
+          }],
         "text": "Specifies the validation status."
       },
       "attribute": "is-valid",
@@ -332,7 +392,10 @@ export class VegaImageUploader {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.14.0"
+          }],
         "text": "Determines whether automatic validation should be\n   implemented for image uploads."
       },
       "attribute": "auto-validation",
@@ -355,7 +418,10 @@ export class VegaImageUploader {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.14.0"
+          }],
         "text": "Specifies custom validation rules for image uploads."
       },
       "defaultValue": "[]"
@@ -371,7 +437,10 @@ export class VegaImageUploader {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "2.5.0"
+          }],
         "text": "Specifies the label or title for the image uploader.\n   It provides descriptive text that helps identify\n   the purpose of the image uploader."
       },
       "attribute": "label",
@@ -389,7 +458,10 @@ export class VegaImageUploader {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "2.9.0"
+          }],
         "text": "Provides a supplementary prompt message that assists users in\n   understanding the expected value for the image uploader field."
       },
       "attribute": "hint",
@@ -406,7 +478,10 @@ export class VegaImageUploader {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "2.9.0"
+          }],
         "text": "Specifies the action title for the image uploader.\n   This property provides descriptive text that identifies\n   the intended action or function of the image uploader."
       },
       "attribute": "action-title",
@@ -424,7 +499,10 @@ export class VegaImageUploader {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "2.9.0"
+          }],
         "text": "Specifies the action sub-title for the image uploader.\n   This property provides descriptive text that identifies\n   the intended action or function of the image uploader."
       },
       "attribute": "action-sub-title",
@@ -450,7 +528,10 @@ export class VegaImageUploader {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "2.9.0"
+          }],
         "text": "Defines the width of the image uploader field."
       },
       "attribute": "width",
@@ -477,7 +558,10 @@ export class VegaImageUploader {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "2.9.0"
+          }],
         "text": "Defines the height of the image uploader field."
       },
       "attribute": "height",
@@ -492,7 +576,10 @@ export class VegaImageUploader {
       "cancelable": true,
       "composed": true,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.14.0"
+          }],
         "text": "An event emitter notifying a value change."
       },
       "complexType": {
@@ -515,6 +602,9 @@ export class VegaImageUploader {
         "tags": [{
             "name": "eventSemantics",
             "text": "namespace:native"
+          }, {
+            "name": "version",
+            "text": "2.0.0"
           }],
         "text": "An event emitter notifying a value change."
       },
@@ -530,7 +620,10 @@ export class VegaImageUploader {
       "cancelable": true,
       "composed": true,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.14.0"
+          }],
         "text": "An event emitter notifying the removal of a value."
       },
       "complexType": {
@@ -548,6 +641,9 @@ export class VegaImageUploader {
         "tags": [{
             "name": "eventSemantics",
             "text": "namespace:native"
+          }, {
+            "name": "version",
+            "text": "2.0.0"
           }],
         "text": "An event emitter notifying the removal of a value."
       },
@@ -563,7 +659,10 @@ export class VegaImageUploader {
       "cancelable": true,
       "composed": true,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.14.0"
+          }],
         "text": "An event emitter notifying the cancellation of an uploading event."
       },
       "complexType": {
@@ -581,6 +680,9 @@ export class VegaImageUploader {
         "tags": [{
             "name": "eventSemantics",
             "text": "namespace:native"
+          }, {
+            "name": "version",
+            "text": "2.0.0"
           }],
         "text": "An event emitter notifying the removal of a value."
       },
@@ -615,7 +717,10 @@ export class VegaImageUploader {
       },
       "docs": {
         "text": "Invoke this method to retrieve the image preview URL for\n   the current selection in the `vega-image-uploader` component.",
-        "tags": []
+        "tags": [{
+            "name": "version",
+            "text": "1.45.0"
+          }]
       }
     }
   }; }