@globalpayments/vega 2.24.0 → 2.25.0

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

@@ -17,7 +17,7 @@ import { ComponentLoadRequired } from '../../decorators/method-decorators/compon
 import { InjectVegaGlobalSlimmer, InjectVegaSlimmer, methodPlaceholder, slotPlaceholder, } from 'vega-slimmer/core';
 import { FormFieldControllerSlimmer } from '../../helpers/slimmers/form-field-controller-slimmer';
 import { createEventEmitSlimmer, } from '../../helpers/event-manager/slimmers/event-emit-slimmer';
-import { VegaBlur, VegaChange, VegaFocus } from '../../helpers/event-manager/event-id/vega-event-id';
+import { VegaBlur, VegaChange, VegaFocus, VegaLabelButtonClick, } from '../../helpers/event-manager/event-id/vega-event-id';
 import { FORM_ELEMENT_VALUE_CHANGE } from '../../helpers/change-manager/subject/static-subject/static-subject-title';
 import ChangeManager from '../../helpers/change-manager/change-manager';
 import { VegaInputCopyPasteController } from './slimmers/controllers/vega-input-copy-paste-controller';
@@ -25,6 +25,10 @@ import { VegaInputPrefixSlotRenderer } from './slimmers/renderers/vega-input-pre
 import { VegaInputMaskConfigController } from './slimmers/controllers/vega-input-mask-config-controller';
 import { VegaComponentUsageRuntimeMetricsSlimmer } from '../../helpers/slimmers/component-usage-runtime-metrics';
 import { VegaInputRuntimeMetricsPayloadDefinition } from '../../constants/runtime-metrics-payload-definition/vega-input/runtime-metrics-payload-definition';
+import { DomNodeSubjectObserverFactory } from '../../helpers/change-manager/subject/dom-node-subject/dom-node-subject-observer-factory';
+/**
+ * @version 1.0.5
+ */
 export class VegaInput {
   constructor() {
     this.globalSlimmers = {};
@@ -71,14 +75,26 @@ export class VegaInput {
     this.changeEventEmitter = createEventEmitSlimmer(VegaInput, VegaChange);
     this.focusEventEmitter = createEventEmitSlimmer(VegaInput, VegaFocus);
     this.blurEventEmitter = createEventEmitSlimmer(VegaInput, VegaBlur);
+    this.labelButtonClickEventEmitter = createEventEmitSlimmer(VegaInput, VegaLabelButtonClick);
     this.vegaComponentUsageRuntimeMetricsSlimmer = new VegaComponentUsageRuntimeMetricsSlimmer(VegaInputRuntimeMetricsPayloadDefinition);
     /**
      * Specifies the label or title for the input field.
      *
      * It provides descriptive text that helps identify the
      *    purpose or content expected in the input field.
+     *
+     * @version 1.0.5
      */
     this.label = '';
+    /**
+     * Specifies the properties for the suffix button associated with the input.
+     *
+     * It provides essential information and functionality
+     *  related to the suffix button's role and behavior.
+     *
+     * @version 2.25.0
+     */
+    this.labelSuffixButtonProps = null;
     /**
      * Represents a pre-set or default value for the input field.
      *
@@ -88,12 +104,17 @@ export class VegaInput {
      *
      * If the value is too long, it may be truncated with
      *    an ellipsis for visual presentation.
+     *
+     * @version 1.0.5
      */
+    /* eslint-disable-next-line @stencil/strict-mutable */
     this.value = '';
     /**
      * Specifies when the vegaChange event is triggered.
      *     It controls whether the event is dispatched
      *     after typing in the input or after a change event.
+     *
+     * @version 2.24.0
      */
     this.valueUpdateTrigger = 'input';
     /**
@@ -101,17 +122,23 @@ export class VegaInput {
      *
      * It specifies the intended format or purpose of the
      *    data to be entered by the user.
+     *
+     * @version 1.0.9
      */
     this.type = 'text';
     /**
      * Defines the specific name of the input field.
      *
+     *
+     * @version 1.0.5
      */
     this.name = '';
     /**
      * Controls the autofill behavior and specifies whether the
      *    input should receive automated suggestions or
      *    previously entered values.
+     *
+     * @version 1.0.5
      */
     this.autocomplete = 'off';
     /**
@@ -121,64 +148,91 @@ export class VegaInput {
      *    standard email formatting rules.
      *
      * @deprecated Please use `type='email'` instead.
+     * @version 1.0.5
      */
     this.email = false;
     /**
      * Determines whether the input field is required.
+     *
+     * @version 1.0.5
      */
     /* eslint-disable-next-line @stencil/strict-mutable */
     this.required = false;
     /**
      * Sets the minimum allowable numeric value for the input value.
+     *
+     * @version 1.0.5
      */
     this.min = null;
     /**
      * Sets the maximum allowable numeric value for the input value.
+     *
+     * @version 1.0.5
      */
     this.max = null;
     /**
      * Sets the minimum length requirement for the input value.
+     *
+     * @version 1.0.5
      */
     this.minLength = null;
     /**
      * Sets the maximum length requirement for the input value.
+     *
+     * @version 1.0.5
      */
     this.maxLength = null;
     /**
      * Determines whether the clear icon should be displayed or hidden.
+     *
+     * @version 1.3.0
      */
     this.showClearIcon = true;
     /**
      * Indicates whether the current value in the field is considered valid or
      *    invalid based on the defined validation rules.
+     *
+     * @version 1.3.0
      */
     /* eslint-disable-next-line @stencil/strict-mutable */
     this.isValid = null;
     /**
      * Determines whether the input field should undergo automatic validation
      *    during the user's input.
+     *
+     * @version 1.0.10
      */
     this.autoValidation = true;
     /**
      * Defines custom validation rules for the input field.
+     *
+     * @version 1.0.10
      */
     this.validationRules = [];
     /**
      * Defines the size of the input field,
      *    specifying its width or length.
+     *
+     * @version 1.3.0
      */
     this.size = 'default';
     /**
      * Determines whether the input field is disabled.
+     *
+     * @version 1.3.0
      */
     this.disabled = false;
     /**
      * Provides a supplementary prompt message that assists users in
      *    understanding the expected value for the input field.
+     *
+     * @version 1.3.0
      */
     this.hint = '';
     /**
      * Controls whether copying or pasting is enabled for the input.
+     *
+     * @version 2.1.0
      */
     this.disableCopyPaste = false;
     this.focusInput = () => {
@@ -224,6 +278,9 @@ export class VegaInput {
         this.value = e.target.value;
       }
     };
+    this.handleLabelButtonClick = () => {
+      this.labelButtonClickEventEmitter.emit();
+    };
   }
   /**
    * The input component is embedded in other components.
@@ -261,12 +318,16 @@ export class VegaInput {
   }
   /**
    * Invoke this method to focus the current input.
+   *
+   * @version 1.12.0
    */
   async doFocus() {
     this.focusInput();
   }
   /**
    * Invoke this method to blur the current input.
+   *
+   * @version 1.12.0
    */
   async doBlur() {
     this.inputRef.blur();
@@ -299,7 +360,9 @@ export class VegaInput {
       this.renderHintDom()));
   }
   renderLabelDom() {
-    return (h("vega-field-label", { onClick: this.focusInput, "is-field-required": this.required, disabled: this.disabled, label: this.label }));
+    return (h("vega-field-label", { onClick: this.focusInput, "is-field-required": this.required, disabled: this.disabled, label: this.label, suffixButtonProps: this.labelSuffixButtonProps, ref: (node) => {
+        DomNodeSubjectObserverFactory.addUniqueObserverToNode(node, VegaLabelButtonClick, this.handleLabelButtonClick);
+      } }));
   }
   renderClearIcon() {
     return (h("div", { class: {
@@ -332,13 +395,40 @@ export class VegaInput {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.0.5"
+          }],
         "text": "Specifies the label or title for the input field.\n\nIt provides descriptive text that helps identify the\n   purpose or content expected in the input field."
       },
       "attribute": "label",
       "reflect": false,
       "defaultValue": "''"
     },
+    "labelSuffixButtonProps": {
+      "type": "unknown",
+      "mutable": false,
+      "complexType": {
+        "original": "LabelSuffixButtonProps",
+        "resolved": "{ icon: string; tooltipText?: string; trigger?: \"click\" | \"hover\"; }",
+        "references": {
+          "LabelSuffixButtonProps": {
+            "location": "import",
+            "path": "../vega-field-label/types"
+          }
+        }
+      },
+      "required": false,
+      "optional": false,
+      "docs": {
+        "tags": [{
+            "name": "version",
+            "text": "2.25.0"
+          }],
+        "text": "Specifies the properties for the suffix button associated with the input.\n\nIt provides essential information and functionality\n related to the suffix button's role and behavior."
+      },
+      "defaultValue": "null"
+    },
     "value": {
       "type": "string",
       "mutable": true,
@@ -350,7 +440,10 @@ export class VegaInput {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.0.5"
+          }],
         "text": "Represents a pre-set or default value for the input field.\n\nIt allows you to initialize the field with a specific value,\n   which is displayed to the user when the input is\n   initially rendered.\n\nIf the value is too long, it may be truncated with\n   an ellipsis for visual presentation."
       },
       "attribute": "value",
@@ -373,7 +466,10 @@ export class VegaInput {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "2.24.0"
+          }],
         "text": "Specifies when the vegaChange event is triggered.\n    It controls whether the event is dispatched\n    after typing in the input or after a change event."
       },
       "attribute": "value-update-trigger",
@@ -391,7 +487,10 @@ export class VegaInput {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.0.9"
+          }],
         "text": "Defines the specific type or category of the input field.\n\nIt specifies the intended format or purpose of the\n   data to be entered by the user."
       },
       "attribute": "type",
@@ -409,7 +508,10 @@ export class VegaInput {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.0.5"
+          }],
         "text": "Defines the specific name of the input field."
       },
       "attribute": "name",
@@ -427,7 +529,10 @@ export class VegaInput {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.0.5"
+          }],
         "text": "Controls the autofill behavior and specifies whether the\n   input should receive automated suggestions or\n   previously entered values."
       },
       "attribute": "autocomplete",
@@ -445,7 +550,10 @@ export class VegaInput {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.0.5"
+          }],
         "text": "Specifies an icon or symbol that appears before the input field,\n   providing visual context or enhancing the aesthetic appearance\n   of the input."
       },
       "attribute": "prefix-icon",
@@ -465,6 +573,9 @@ export class VegaInput {
         "tags": [{
             "name": "deprecated",
             "text": "Please use `type='email'` instead."
+          }, {
+            "name": "version",
+            "text": "1.0.5"
           }],
         "text": "Enforces proper email format validation for the input field.\n\nIt ensures that the user enters a valid email address according to\n   standard email formatting rules."
       },
@@ -483,7 +594,10 @@ export class VegaInput {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.0.5"
+          }],
         "text": "Determines whether the input field is required."
       },
       "attribute": "required",
@@ -501,7 +615,10 @@ export class VegaInput {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.0.5"
+          }],
         "text": "Sets the minimum allowable numeric value for the input value."
       },
       "attribute": "min",
@@ -519,7 +636,10 @@ export class VegaInput {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.0.5"
+          }],
         "text": "Sets the maximum allowable numeric value for the input value."
       },
       "attribute": "max",
@@ -537,7 +657,10 @@ export class VegaInput {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.0.5"
+          }],
         "text": "Sets the minimum length requirement for the input value."
       },
       "attribute": "min-length",
@@ -555,7 +678,10 @@ export class VegaInput {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.0.5"
+          }],
         "text": "Sets the maximum length requirement for the input value."
       },
       "attribute": "max-length",
@@ -573,7 +699,10 @@ export class VegaInput {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.3.0"
+          }],
         "text": "Determines whether the clear icon should be displayed or hidden."
       },
       "attribute": "show-clear-icon",
@@ -591,7 +720,10 @@ export class VegaInput {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.3.0"
+          }],
         "text": "Indicates whether the current value in the field is considered valid or\n   invalid based on the defined validation rules."
       },
       "attribute": "is-valid",
@@ -609,7 +741,10 @@ export class VegaInput {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.0.10"
+          }],
         "text": "Determines whether the input field should undergo automatic validation\n   during the user's input."
       },
       "attribute": "auto-validation",
@@ -632,7 +767,10 @@ export class VegaInput {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.0.10"
+          }],
         "text": "Defines custom validation rules for the input field."
       },
       "defaultValue": "[]"
@@ -648,7 +786,10 @@ export class VegaInput {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.3.0"
+          }],
         "text": "Defines the size of the input field,\n   specifying its width or length."
       },
       "attribute": "size",
@@ -666,7 +807,10 @@ export class VegaInput {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.3.0"
+          }],
         "text": "Specifies a placeholder string that displays as a temporary hint\n   or example inside the input field.\n\nIt indicates the expected format or pattern of the input."
       },
       "attribute": "placeholder",
@@ -683,7 +827,10 @@ export class VegaInput {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.3.0"
+          }],
         "text": "Determines whether the input field is disabled."
       },
       "attribute": "disabled",
@@ -701,7 +848,10 @@ export class VegaInput {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.3.0"
+          }],
         "text": "Provides a supplementary prompt message that assists users in\n   understanding the expected value for the input field."
       },
       "attribute": "hint",
@@ -724,7 +874,10 @@ export class VegaInput {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.3.0"
+          }],
         "text": "Specifies the configuration for applying a mask to the input field.\n\nIt provides a way to define a specific format or pattern for the input value,\n   restricting and guiding the user's input accordingly."
       }
     },
@@ -739,7 +892,10 @@ export class VegaInput {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "2.1.0"
+          }],
         "text": "Controls whether copying or pasting is enabled for the input."
       },
       "attribute": "disable-copy-paste",
@@ -754,7 +910,10 @@ export class VegaInput {
       "cancelable": true,
       "composed": true,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.0.10"
+          }],
         "text": "An event emitter notifying a value change."
       },
       "complexType": {
@@ -772,6 +931,9 @@ export class VegaInput {
         "tags": [{
             "name": "eventSemantics",
             "text": "namespace:native"
+          }, {
+            "name": "version",
+            "text": "2.0.0"
           }],
         "text": "An event emitter notifying a value change."
       },
@@ -787,7 +949,10 @@ export class VegaInput {
       "cancelable": true,
       "composed": true,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.3.0"
+          }],
         "text": "An event emitter notifying the blur of the inner input element."
       },
       "complexType": {
@@ -805,6 +970,9 @@ export class VegaInput {
         "tags": [{
             "name": "eventSemantics",
             "text": "namespace:native"
+          }, {
+            "name": "version",
+            "text": "2.0.0"
           }],
         "text": "An event emitter notifying the blur of the inner input element."
       },
@@ -820,7 +988,10 @@ export class VegaInput {
       "cancelable": true,
       "composed": true,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.12.0"
+          }],
         "text": "An event emitter notifying the focus of the inner input element."
       },
       "complexType": {
@@ -838,6 +1009,9 @@ export class VegaInput {
         "tags": [{
             "name": "eventSemantics",
             "text": "namespace:native"
+          }, {
+            "name": "version",
+            "text": "2.0.0"
           }],
         "text": "An event emitter notifying the focus of the inner input element."
       },
@@ -846,6 +1020,45 @@ export class VegaInput {
         "resolved": "undefined",
         "references": {}
       }
+    }, {
+      "method": "vegaLabelButtonClick",
+      "name": "vegaLabelButtonClick",
+      "bubbles": true,
+      "cancelable": true,
+      "composed": true,
+      "docs": {
+        "tags": [{
+            "name": "version",
+            "text": "2.25.0"
+          }],
+        "text": "An event emitter notifying that the suffix button associated with the field label has been clicked."
+      },
+      "complexType": {
+        "original": "any",
+        "resolved": "any",
+        "references": {}
+      }
+    }, {
+      "method": "labelButtonClick",
+      "name": "labelButtonClick",
+      "bubbles": true,
+      "cancelable": true,
+      "composed": true,
+      "docs": {
+        "tags": [{
+            "name": "eventSemantics",
+            "text": "namespace:native"
+          }, {
+            "name": "version",
+            "text": "2.25.0"
+          }],
+        "text": "An event emitter notifying that the suffix button associated with the field label has been clicked."
+      },
+      "complexType": {
+        "original": "any",
+        "resolved": "any",
+        "references": {}
+      }
     }]; }
   static get methods() { return {
     "doFocus": {
@@ -861,7 +1074,10 @@ export class VegaInput {
       },
       "docs": {
         "text": "Invoke this method to focus the current input.",
-        "tags": []
+        "tags": [{
+            "name": "version",
+            "text": "1.12.0"
+          }]
       }
     },
     "doBlur": {
@@ -877,7 +1093,10 @@ export class VegaInput {
       },
       "docs": {
         "text": "Invoke this method to blur the current input.",
-        "tags": []
+        "tags": [{
+            "name": "version",
+            "text": "1.12.0"
+          }]
       }
     }
   }; }
@@ -917,6 +1136,9 @@ __decorate([
 __decorate([
   InjectVegaSlimmer()
 ], VegaInput.prototype, "blurEventEmitter", void 0);
+__decorate([
+  InjectVegaSlimmer()
+], VegaInput.prototype, "labelButtonClickEventEmitter", void 0);
 __decorate([
   InjectVegaSlimmer()
 ], VegaInput.prototype, "vegaComponentUsageRuntimeMetricsSlimmer", void 0);