@globalpayments/vega 2.24.0 → 2.25.0

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

@@ -28,6 +28,9 @@ import { DROPDOWN_ITEM_CLICK } from '../../helpers/change-manager/subject/static
 import { VegaComponentUsageRuntimeMetricsSlimmer } from '../../helpers/slimmers/component-usage-runtime-metrics';
 import { VegaDropdownRuntimeMetricsPayloadDefinition } from '../../constants/runtime-metrics-payload-definition/vega-dropdown/runtime-metrics-payload-definition';
 import { VegaDropdownScrollableController } from './slimmers/controllers/vega-dropdown-scrollable-controller';
+/**
+ * @version 1.3.0
+ */
 export class VegaDropdown {
   constructor() {
     this.globalSlimmers = {};
@@ -64,6 +67,8 @@ export class VegaDropdown {
     this.isDropdownShow = false;
     /**
      * Specifies the trigger mode for the dropdown.
+     *
+     * @version 1.3.0
      */
     this.trigger = 'hover';
     /**
@@ -71,6 +76,8 @@ export class VegaDropdown {
      *    relative to the target element.
      *
      * By default, the dropdown is displayed on the left-bottom of the target.
+     *
+     * @version 1.3.0
      */
     this.translocation = {
       X: 0,
@@ -79,8 +86,10 @@ export class VegaDropdown {
     /**
      * Sets the source array of items for the dropdown,
      *    where each item must have a `key` and `label` property.
+     *
+     * @version 1.3.0
      */
-    /* eslint-disable @stencil/strict-mutable */
+    /* eslint-disable-next-line @stencil/strict-mutable */
     this.source = [];
     /**
      * Controls the dropdown menu's selection. It accepts three values:
@@ -96,32 +105,47 @@ export class VegaDropdown {
      *      When an item with a key found in the `selectedSourceKey` array is selected,
      *      this mode releases the `vegaDropdownClick` event. Unlike the others, however,
      *      Determines the selection mode for multiple item selection.
+     *
+     * @version 1.3.0
      */
     this.selectType = 'none';
     /**
      * Represents the key corresponding to the selected item in the dropdown menu.
      *    It becomes active only when `selectType` is set to `single` or `multiple`.
+     *
+     * @version 1.3.0
      */
+    /* eslint-disable-next-line @stencil/strict-mutable */
     this.selectedSourceKey = this.selectType === 'multiple' ? [] : '';
     /**
      * Controls whether the prefix icon occupy a position, even if prefix has no value.
+     *
+     * @version 1.47.0
      */
     this.prefixIconSlot = false;
     /**
      * Specifies the maximum height for the dropdown.
+     *
+     * @version 1.3.0
      */
     this.maxHeight = 400;
     /**
      * Controls whether the dropdown list can be searched.
+     *
+     * @version 1.3.0
      */
     this.searchable = false;
     /**
      * Determines whether the dropdown should have the
      *    same width as the target element.
+     *
+     * @version 1.3.0
      */
     this.matchTargetWidth = false;
     /**
      * Specifies the display rule for items in the dropdown.
+     *
+     * @version 1.13.0
      */
     this.itemDisplayRule = 'newline';
     /**
@@ -130,6 +154,8 @@ export class VegaDropdown {
      *
      * If set to `true`, the dropdown will always be positioned at
      *    the bottom of the available space.
+     *
+     * @version 1.3.0
      */
     this.matchContainerHeight = false;
     /**
@@ -137,12 +163,16 @@ export class VegaDropdown {
      *
      * Note that the default filter rules are fuzzy matching and case-insensitive.
      *    This parameter only takes effect when `searchable` is set to `true`.
+     *
+     * @version 1.4.0
      */
     this.caseSensitive = false;
     /**
      * Controls whether the dropdown can add a new item when
      *    no proper item is available. It becomes active only when
      *    `searchable` is set to `true`.
+     *
+     * @version 1.16.0
      */
     this.dynamicOption = false;
     /**
@@ -154,24 +184,34 @@ export class VegaDropdown {
      *
      * Note that the `dynamicOption` property will not work when
      *    this property is set to `false`.
+     *
+     * @version 1.24.0
      */
     this.useDefaultFilter = true;
     /**
      * Determines whether the dropdown displays a loading status.
+     *
+     * @version 1.24.0
      */
     this.isLoading = false;
     /**
      * Specifies the vertical positioning of the dropdown
      *    within its container or relative to a reference point.
+     *
+     * @version 1.41.0
      */
     this.placement = ['bottom', 'top'];
     /**
      * Determines the horizontal positioning of the dropdown
      *    within its container or relative to a reference point.
+     *
+     * @version 1.41.0
      */
     this.alignment = 'start';
     /**
      * Determines whether the dropdown displays a lazy loading status.
+     *
+     * @version 2.3.0
      */
     this.isLazyLoading = false;
   }
@@ -195,12 +235,16 @@ export class VegaDropdown {
   }
   /**
    * Invoke this method to programmatically display the dropdown menu.
+   *
+   * @version 1.3.0
    */
   async show() {
     methodPlaceholder();
   }
   /**
    * Invoke this method to programmatically dismiss the dropdown menu.
+   *
+   * @version 1.3.0
    */
   async hide() {
     methodPlaceholder();
@@ -210,6 +254,8 @@ export class VegaDropdown {
    *    filter the list of items in the dropdown.
    *
    * This method is applicable only when the dropdown is searchable.
+   *
+   * @version 1.11.0
    */
   async search(input) {
     methodPlaceholder(input);
@@ -217,6 +263,8 @@ export class VegaDropdown {
   /**
    * Invoke this method to clear the selected items keys,
    *    removing any current selection.
+   *
+   * @version 1.47.0
    */
   async clearSelection() {
     methodPlaceholder();
@@ -225,6 +273,8 @@ export class VegaDropdown {
    * Invoke this method to retrieve the selected items keys,
    *    providing an key or list of the keys representing
    *    the currently selected items.
+   *
+   * @version 1.47.0
    */
   async getSelection() {
     return methodPlaceholder();
@@ -235,6 +285,7 @@ export class VegaDropdown {
    *    the desired selected items.
    *
    * @param {string[]} keys - Row keys to be set as selected.
+   * @version 1.47.0
    */
   async setSelection(keys) {
     methodPlaceholder(keys);
@@ -272,7 +323,10 @@ export class VegaDropdown {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.3.0"
+          }],
         "text": "Specifies the size of the dropdown.\n   It can be provided as a number or a ResponsiveType.\n\nIf no size is set, the dropdown will default to fitting the item content width."
       },
       "attribute": "size",
@@ -289,7 +343,10 @@ export class VegaDropdown {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.3.0"
+          }],
         "text": "Specifies the trigger mode for the dropdown."
       },
       "attribute": "trigger",
@@ -316,7 +373,10 @@ export class VegaDropdown {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.3.0"
+          }],
         "text": "Specifies the position adjustment for the dropdown\n   relative to the target element.\n\nBy default, the dropdown is displayed on the left-bottom of the target."
       },
       "defaultValue": "{\n\t\tX: 0,\n\t\tY: 8,\n\t}"
@@ -337,7 +397,10 @@ export class VegaDropdown {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.3.0"
+          }],
         "text": "Sets the source array of items for the dropdown,\n   where each item must have a `key` and `label` property."
       },
       "defaultValue": "[]"
@@ -353,7 +416,10 @@ export class VegaDropdown {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.3.0"
+          }],
         "text": "Specifies the relative positioning of the dropdown menu\n   in relation to its container.\n\nIf not specified, the dropdown will be appended to the menu by default.\n   Adjust this property when facing scrolling positioning problems."
       },
       "attribute": "position-relative-to",
@@ -370,7 +436,10 @@ export class VegaDropdown {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.3.0"
+          }],
         "text": "Controls the dropdown menu's selection. It accepts three values:\n\n- `none`:\n     After an item is selected, this option not only triggers the `vegaDropdownClick`\n     event but also conceals the dropdown menu immediately.\n- `single`:\n     Upon selection of an item whose key matches the `selectedSourceKey` property,\n     this setting both dispatches the `vegaDropdownClick` event and\n     hides the dropdown menu.\n- `multiple`:\n     When an item with a key found in the `selectedSourceKey` array is selected,\n     this mode releases the `vegaDropdownClick` event. Unlike the others, however,\n     Determines the selection mode for multiple item selection."
       },
       "attribute": "select-type",
@@ -388,7 +457,10 @@ export class VegaDropdown {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.3.0"
+          }],
         "text": "Represents the key corresponding to the selected item in the dropdown menu.\n   It becomes active only when `selectType` is set to `single` or `multiple`."
       },
       "attribute": "selected-source-key",
@@ -406,7 +478,10 @@ export class VegaDropdown {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.47.0"
+          }],
         "text": "Controls whether the prefix icon occupy a position, even if prefix has no value."
       },
       "attribute": "prefix-icon-slot",
@@ -424,7 +499,10 @@ export class VegaDropdown {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.3.0"
+          }],
         "text": "Specifies the maximum height for the dropdown."
       },
       "attribute": "max-height",
@@ -442,7 +520,10 @@ export class VegaDropdown {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.3.0"
+          }],
         "text": "Controls whether the dropdown list can be searched."
       },
       "attribute": "searchable",
@@ -460,7 +541,10 @@ export class VegaDropdown {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.3.0"
+          }],
         "text": "Determines whether the dropdown should have the\n   same width as the target element."
       },
       "attribute": "match-target-width",
@@ -487,7 +571,10 @@ export class VegaDropdown {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.13.0"
+          }],
         "text": "Specifies the minimum width of the dropdown. It can be provided as\n   a number or a ResponsiveType."
       },
       "attribute": "min-width",
@@ -513,7 +600,10 @@ export class VegaDropdown {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.13.0"
+          }],
         "text": "Specifies the maximum width of the dropdown. It can be provided as\n   a number or a ResponsiveType."
       },
       "attribute": "max-width",
@@ -530,7 +620,10 @@ export class VegaDropdown {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.13.0"
+          }],
         "text": "Specifies the display rule for items in the dropdown."
       },
       "attribute": "item-display-rule",
@@ -548,7 +641,10 @@ export class VegaDropdown {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.3.0"
+          }],
         "text": "Determines if the dropdown height should be automatically adjusted\n   to fit its container height.\n\nIf set to `true`, the dropdown will always be positioned at\n   the bottom of the available space."
       },
       "attribute": "match-container-height",
@@ -566,7 +662,10 @@ export class VegaDropdown {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.4.0"
+          }],
         "text": "Specifies whether the search source list is case-sensitive.\n\nNote that the default filter rules are fuzzy matching and case-insensitive.\n   This parameter only takes effect when `searchable` is set to `true`."
       },
       "attribute": "case-sensitive",
@@ -584,7 +683,10 @@ export class VegaDropdown {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.16.0"
+          }],
         "text": "Controls whether the dropdown can add a new item when\n   no proper item is available. It becomes active only when\n   `searchable` is set to `true`."
       },
       "attribute": "dynamic-option",
@@ -602,7 +704,10 @@ export class VegaDropdown {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.24.0"
+          }],
         "text": "Determines whether to enable source filtering based on input words.\n\nWhen set to 'false', the component will emit a `vegaSearch` event\n   when input words are provided. In this case, you are responsible for\n   managing the source, including adding, deleting, and updating the source.\n\nNote that the `dynamicOption` property will not work when\n   this property is set to `false`."
       },
       "attribute": "use-default-filter",
@@ -620,7 +725,10 @@ export class VegaDropdown {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.24.0"
+          }],
         "text": "Determines whether the dropdown displays a loading status."
       },
       "attribute": "is-loading",
@@ -643,7 +751,10 @@ export class VegaDropdown {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.41.0"
+          }],
         "text": "Specifies the vertical positioning of the dropdown\n   within its container or relative to a reference point."
       },
       "attribute": "placement",
@@ -666,7 +777,10 @@ export class VegaDropdown {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.41.0"
+          }],
         "text": "Determines the horizontal positioning of the dropdown\n   within its container or relative to a reference point."
       },
       "attribute": "alignment",
@@ -684,7 +798,10 @@ export class VegaDropdown {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "2.3.0"
+          }],
         "text": "Determines whether the dropdown displays a lazy loading status."
       },
       "attribute": "is-lazy-loading",
@@ -704,7 +821,10 @@ export class VegaDropdown {
       "cancelable": true,
       "composed": true,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.11.0"
+          }],
         "text": "An event emitter notifying that a dropdown item has been clicked.\n\nThe event's `detail` property contains the key of the clicked item."
       },
       "complexType": {
@@ -722,6 +842,9 @@ export class VegaDropdown {
         "tags": [{
             "name": "eventSemantics",
             "text": "namespace:native"
+          }, {
+            "name": "version",
+            "text": "2.0.0"
           }],
         "text": "An event emitter notifying that a dropdown item has been clicked.\n\nThe event's `detail` property contains the key of the clicked item."
       },
@@ -737,7 +860,10 @@ export class VegaDropdown {
       "cancelable": true,
       "composed": true,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.3.0"
+          }],
         "text": "An event emitter notifying that the dropdown has been displayed,\n   either programmatically or via user interaction."
       },
       "complexType": {
@@ -755,6 +881,9 @@ export class VegaDropdown {
         "tags": [{
             "name": "eventSemantics",
             "text": "namespace:native"
+          }, {
+            "name": "version",
+            "text": "2.0.0"
           }],
         "text": "An event emitter notifying that the dropdown has been displayed,\n   either programmatically or via user interaction. The name is not `show` because already has a method `show`."
       },
@@ -770,7 +899,10 @@ export class VegaDropdown {
       "cancelable": true,
       "composed": true,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.3.0"
+          }],
         "text": "Event emitter notifying that the dropdown has been dismissed,\n   either programmatically or via user interaction."
       },
       "complexType": {
@@ -788,6 +920,9 @@ export class VegaDropdown {
         "tags": [{
             "name": "eventSemantics",
             "text": "namespace:native"
+          }, {
+            "name": "version",
+            "text": "2.0.0"
           }],
         "text": "An event emitter notifying that the dropdown has been dismissed,\n   either programmatically or via user interaction. The name is not `hide` because already has a method `hide`."
       },
@@ -803,7 +938,10 @@ export class VegaDropdown {
       "cancelable": true,
       "composed": true,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.14.0"
+          }],
         "text": "An event emitter notifying the addition of a new value\n   to the dropdown source list.\n\nThe event's `detail` property contains the new value.\n\nThe dropdown _does not_ automatically add the new value to the source list."
       },
       "complexType": {
@@ -821,6 +959,9 @@ export class VegaDropdown {
         "tags": [{
             "name": "eventSemantics",
             "text": "namespace:native"
+          }, {
+            "name": "version",
+            "text": "2.0.0"
           }],
         "text": "An event emitter notifying the addition of a new value\n   to the dropdown source list.\n\nThe event's `detail` property contains the new value.\n\nThe dropdown _does not_ automatically add the new value to the source list."
       },
@@ -836,7 +977,10 @@ export class VegaDropdown {
       "cancelable": true,
       "composed": true,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.24.0"
+          }],
         "text": "An event emitter notifying the search event in the dropdown,\n   but only if `useDefaultFilter` is set to `false`."
       },
       "complexType": {
@@ -854,6 +998,9 @@ export class VegaDropdown {
         "tags": [{
             "name": "eventSemantics",
             "text": "namespace:native"
+          }, {
+            "name": "version",
+            "text": "2.0.0"
           }],
         "text": "An event emitter notifying the search event in the dropdown,\n   but only if `useDefaultFilter` is set to `false`. The name is not `search` because already has a method `search`."
       },
@@ -877,7 +1024,10 @@ export class VegaDropdown {
       },
       "docs": {
         "text": "Invoke this method to programmatically display the dropdown menu.",
-        "tags": []
+        "tags": [{
+            "name": "version",
+            "text": "1.3.0"
+          }]
       }
     },
     "hide": {
@@ -893,7 +1043,10 @@ export class VegaDropdown {
       },
       "docs": {
         "text": "Invoke this method to programmatically dismiss the dropdown menu.",
-        "tags": []
+        "tags": [{
+            "name": "version",
+            "text": "1.3.0"
+          }]
       }
     },
     "search": {
@@ -912,7 +1065,10 @@ export class VegaDropdown {
       },
       "docs": {
         "text": "Invoke this method to set the search input value and\n   filter the list of items in the dropdown.\n\nThis method is applicable only when the dropdown is searchable.",
-        "tags": []
+        "tags": [{
+            "name": "version",
+            "text": "1.11.0"
+          }]
       }
     },
     "clearSelection": {
@@ -928,7 +1084,10 @@ export class VegaDropdown {
       },
       "docs": {
         "text": "Invoke this method to clear the selected items keys,\n   removing any current selection.",
-        "tags": []
+        "tags": [{
+            "name": "version",
+            "text": "1.47.0"
+          }]
       }
     },
     "getSelection": {
@@ -944,7 +1103,10 @@ export class VegaDropdown {
       },
       "docs": {
         "text": "Invoke this method to retrieve the selected items keys,\n   providing an key or list of the keys representing\n   the currently selected items.",
-        "tags": []
+        "tags": [{
+            "name": "version",
+            "text": "1.47.0"
+          }]
       }
     },
     "setSelection": {
@@ -969,6 +1131,9 @@ export class VegaDropdown {
         "tags": [{
             "name": "param",
             "text": "keys - Row keys to be set as selected."
+          }, {
+            "name": "version",
+            "text": "1.47.0"
           }]
       }
     }

package/dist/collection/components/vega-field-error/vega-field-error.js

@@ -9,6 +9,9 @@ import { sanitizeVegaComponent } from '../../utils/component';
 import { InjectVegaGlobalSlimmer, InjectVegaSlimmer, methodPlaceholder, } from 'vega-slimmer/core';
 import { VegaFieldErrorMessageController } from './slimmers/controllers/vega-field-error-message-controller';
 import { VegaComponentUsageRuntimeMetricsSlimmer } from '../../helpers/slimmers/component-usage-runtime-metrics';
+/**
+ * @version 1.45.0
+ */
 /** The VegaFieldBox class is a TypeScript React component that renders a box with a message and a slot for additional content. */
 export class VegaFieldError {
   constructor() {
@@ -18,6 +21,8 @@ export class VegaFieldError {
     /**
      * Specifies the error message when the input field should display an error.
      *    The input field will clear the error status when the message is empty.
+     *
+     * @version 1.45.0
      */
     this.message = '';
   }
@@ -48,7 +53,10 @@ export class VegaFieldError {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.45.0"
+          }],
         "text": "Specifies the error message when the input field should display an error.\n   The input field will clear the error status when the message is empty."
       },
       "attribute": "message",