@globalpayments/vega 2.24.0 → 2.24.2

package/dist/types/components/vega-textarea/vega-textarea.d.ts

@@ -5,6 +5,9 @@ import { FormFieldControllerSlimmer } from '../../helpers/slimmers/form-field-co
 import { EventEmitSlimmerBase } from '../../helpers/event-manager/slimmers/event-emit-slimmer';
 import { ChildNodesEventPreventSlimmer } from '../../helpers/event-manager/slimmers/child-nodes-event-prevent-slimmer';
 import { VegaComponentUsageRuntimeMetricsSlimmer } from '../../helpers/slimmers/component-usage-runtime-metrics';
+/**
+ * @version 1.11.0
+ */
 export declare class VegaTextarea {
   protected readonly globalSlimmers: GlobalSlimmers;
   protected readonly formFieldController: FormFieldControllerSlimmer<string>;
@@ -22,15 +25,21 @@ export declare class VegaTextarea {
    *
    * It indicates the expected format or pattern of
    *    the input within the text area.
+   *
+   * @version 1.11.0
    */
   placeholder: string;
   /**
    * Provides a supplementary prompt message that assists users in
    *    understanding the expected value within the text area.
+   *
+   * @version 1.11.0
    */
   hint: string;
   /**
    * Specifies whether the text area is disabled.
+   *
+   * @version 1.11.0
    */
   disabled: boolean;
   /**
@@ -38,56 +47,78 @@ export declare class VegaTextarea {
    *
    * It provides descriptive text that helps identify the
    *    purpose or content expected within the text area.
+   *
+   * @version 1.11.0
    */
   label: string;
   /**
    * Determines whether to display a character counter
    *    for the textarea.
+   *
+   * @version 1.11.0
    */
   showCounter: boolean;
   /**
    * Specifies the initial value or content of the
    *    textarea field.
+   *
+   * @version 1.11.0
    */
   value: string;
   watchValue(value: string): void;
   /**
    * Specifies the validation status of the
    *    text area component.
+   *
+   * @version 1.11.0
    */
   isValid: boolean;
   /**
    * Determines whether automatic validation should be
    *    implemented for the text area.
+   *
+   * @version 1.11.0
    */
   autoValidation: boolean;
   /**
    * Determines whether the content of the textarea must be
    *    provided by the user before submitting the form or
    *    completing the input process.
+   *
+   * @version 1.11.0
    */
   required: boolean;
   /**
    * Specifies the maximum number of characters (UTF-16 code units)
    *    that the user can enter in the text area.
+   *
+   * @version 1.11.0
    */
   maxLength: number;
   /** Specifies the minimum number of characters (UTF-16 code units)
    *    that the user must enter in the text area.
+   *
+   * @version 1.11.0
    */
   minLength: number;
   /**
    * Determines whether the text area is vertically resizable.
+   *
+   * @version 2.19.0
    */
   resizable: boolean;
   /**
    * Specifies custom validation rules for the text area.
+   *
+   * @version 1.11.0
    */
   validationRules: FormFieldValidationRule<unknown>[];
   watchValidationRules(): void;
   /**
    * An event emitter notifying about changes in the value
    *    of the text area.
+   *
+   * @version 1.11.0
    */
   vegaChange: EventEmitter<string>;
   /**
@@ -95,11 +126,14 @@ export declare class VegaTextarea {
    *    of the text area.
    *
    * @eventSemantics namespace:native
+   * @version 2.0.0
    */
   change: EventEmitter<string>;
   /**
    * An event emitter notifying the blur event of the inner
    *    textarea element within the text area.
+   *
+   * @version 1.11.0
    */
   vegaBlur: EventEmitter<undefined>;
   /**
@@ -107,6 +141,7 @@ export declare class VegaTextarea {
    *    textarea element within the text area.
    *
    * @eventSemantics namespace:native
+   * @version 2.0.0
    */
   blur: EventEmitter<undefined>;
   componentWillLoad(): void;

package/dist/types/components/vega-time-picker/vega-time-picker-dropdown/vega-time-picker-dropdown.d.ts

@@ -1,5 +1,8 @@
 import { GlobalSlimmers } from '../../../vega-slimmer/vega-slimmer-core';
 import { VegaComponentUsageRuntimeMetricsSlimmer } from '../../../helpers/slimmers/component-usage-runtime-metrics';
+/**
+ * @version 2.0.0
+ */
 export declare class VegaTimePickerDropdown {
   protected readonly globalSlimmers: GlobalSlimmers;
   protected vegaComponentUsageRuntimeMetricsSlimmer: VegaComponentUsageRuntimeMetricsSlimmer<HTMLVegaTimePickerDropdownElement>;

package/dist/types/components/vega-time-picker/vega-time-picker.d.ts

@@ -19,6 +19,9 @@ import { VegaTimePickerRangeDropdownController } from './slimmers/controllers/ve
 import { ChildNodesEventPreventSlimmer } from '../../helpers/event-manager/slimmers/child-nodes-event-prevent-slimmer';
 import { EventEmitSlimmerBase } from '../../helpers/event-manager/slimmers/event-emit-slimmer';
 import { VegaComponentUsageRuntimeMetricsSlimmer } from '../../helpers/slimmers/component-usage-runtime-metrics';
+/**
+ * @version 1.12.0
+ */
 export declare class VegaTimePicker {
   protected readonly globalSlimmers: GlobalSlimmers;
   protected readonly labelRenderer: VegaTimePickerLabelRenderer;
@@ -56,6 +59,8 @@ export declare class VegaTimePicker {
    *
    * It provides descriptive text that helps identify the
    *    purpose or content expected in the time picker.
+   *
+   * @version 1.12.0
    */
   label: string;
   /**
@@ -63,6 +68,8 @@ export declare class VegaTimePicker {
    *
    *  - `single` indicates the ability to select a single time.
    *  - `range` indicates the ability to select a time range.
+   *
+   * @version 1.48.0
    */
   mode: TimePickerModeType;
   /** Update timePicker settings property of mode is changed */
@@ -70,52 +77,72 @@ export declare class VegaTimePicker {
   /**
    * Specifies whether selecting a time in the time picker
    *    is required for passing form validation.
+   *
+   * @version 1.12.0
    */
   required: boolean;
   /**
    * Specifies placeholder strings that provide a temporary hint
    *    or example inside the time input field.
+   *
+   * @version 1.12.0
    */
   placeholder: string | string[];
   /**
    * Determines the interval between each selectable minute value
    *    in the time picker.
+   *
+   * @version 1.12.0
    */
   increments: number;
   watchIncrements(): void;
   /**
    * Specifies the format in which the time is displayed
    *    in the time picker.
+   *
+   * @version 1.12.0
    */
   timeFormat: TimeFormat;
   watchTimeFormat(): void;
   /**
    * Specifies the initial value or selected time
    *    for the time picker.
+   *
+   * @version 1.12.0
    */
   value: TimePickerValueType<TimePickerModeType>;
   watchValue(newValue: TimePickerValueType<TimePickerModeType>, oldValue: TimePickerValueType<TimePickerModeType>): void;
   /**
    * Determines the size or dimensions of the time picker component.
+   *
+   * @version 1.12.0
    */
   size: 'default' | 'small';
   /**
    * Determines whether the time picker component is disabled.
+   *
+   * @version 1.12.0
    */
   disabled: boolean;
   watchDisabled(): void;
   /**
    * Specifies the validation status of the time picker component.
+   *
+   * @version 1.12.0
    */
   isValid: boolean | null;
   /**
    * Determines whether automatic validation should be implemented
    *    for the time picker during user input.
+   *
+   * @version 1.12.0
    */
   autoValidation: boolean;
   /**
    * Specifies custom validation rules for the
    *    time picker input field.
+   *
+   * @version 1.12.0
    */
   validationRules: FormFieldValidationRule<unknown>[];
   watchValidationRules(): void;
@@ -126,16 +153,21 @@ export declare class VegaTimePicker {
    * If not provided, the popup will be appended to
    *    the body by default. Adjust this property
    *    when facing scrolling positioning problems.
+   *
+   * @version 1.12.0
    */
   positionRelativeTo: string;
   /**
    * An event emitter notifying changes in the value of the time picker.
+   *
+   * @version 1.12.0
    */
   vegaChange: EventEmitter<string | string[]>;
   /**
    * An event emitter notifying changes in the value of the time picker.
    *
    * @eventSemantics namespace:native
+   * @version 2.0.0
    */
   change: EventEmitter<string | string[]>;
   componentWillLoad(): void;

package/dist/types/components/vega-toggle-switch/vega-toggle-switch.d.ts

@@ -2,34 +2,48 @@ import { EventEmitter } from '../../stencil-public-runtime';
 import { EventEmitSlimmerBase } from '../../helpers/event-manager/slimmers/event-emit-slimmer';
 import { GlobalSlimmers } from '../../vega-slimmer/vega-slimmer-core';
 import { VegaComponentUsageRuntimeMetricsSlimmer } from '../../helpers/slimmers/component-usage-runtime-metrics';
+/**
+ * @version 1.3.0
+ */
 export declare class VegaToggleSwitch {
   protected readonly globalSlimmers: GlobalSlimmers;
   protected vegaComponentUsageRuntimeMetricsSlimmer: VegaComponentUsageRuntimeMetricsSlimmer<HTMLVegaToggleSwitchElement>;
   protected changeEventEmitter: EventEmitSlimmerBase;
   host: HTMLVegaToggleSwitchElement;
-  /** Specifies whether the toggle switch is in the checked state. */
+  /** Specifies whether the toggle switch is in the checked state. *
+   * @version 1.3.0
+   */
   checked: boolean;
   watchCheckedChange(): void;
   /**
    * Specifies the size of the toggle switch.
+   *
+   * @version 1.3.0
    */
   size: 'default' | 'small';
   /**
    * Specifies the label or title for the toggle switch.
+   *
+   * @version 1.3.0
    */
   label: string;
   /**
    * Specifies whether the toggle switch is disabled.
+   *
+   * @version 1.3.0
    */
   disabled: boolean;
   /**
    * An event emitter notifying changes in the toggle switch.
+   *
+   * @version 1.3.0
    */
   vegaChange: EventEmitter<boolean>;
   /**
    * An event emitter notifying changes in the toggle switch.
    *
    * @eventSemantics namespace:native
+   * @version 2.0.0
    */
   change: EventEmitter<boolean>;
   render(): VegaToggleSwitch;

package/dist/types/components/vega-tooltip/vega-tooltip-content-box/vega-tooltip-content-box.d.ts

@@ -1,11 +1,16 @@
 import { GlobalSlimmers } from '../../../vega-slimmer/vega-slimmer-core';
 import { VegaComponentUsageRuntimeMetricsSlimmer } from '../../../helpers/slimmers/component-usage-runtime-metrics';
+/**
+ * @version 2.0.0
+ */
 export declare class VegaTooltipContentBox {
   protected readonly globalSlimmers: GlobalSlimmers;
   protected vegaComponentUsageRuntimeMetricsSlimmer: VegaComponentUsageRuntimeMetricsSlimmer<HTMLVegaTooltipContentBoxElement>;
   host: HTMLVegaTooltipContentBoxElement;
   /**
    * Specifies the text that is displayed inside the tooltip.
+   *
+   * @version 2.0.0
    */
   text: string;
   render(): VegaTooltipContentBox;

package/dist/types/components/vega-tooltip/vega-tooltip.d.ts

@@ -4,6 +4,9 @@ import { VegaTooltipElementAppenderController } from './slimmers/controllers/veg
 import { VegaTooltipContentBoxRenderer } from './slimmers/renderers/vega-tooltip-content-box-renderer';
 import { DeprecatedPropertySlimmerBase } from '../../helpers/slimmers/deprecated-property-slimmer';
 import { VegaComponentUsageRuntimeMetricsSlimmer } from '../../helpers/slimmers/component-usage-runtime-metrics';
+/**
+ * @version 1.3.0
+ */
 export declare class VegaTooltip {
   protected readonly globalSlimmers: GlobalSlimmers;
   protected readonly vegaTooltipElementAppenderController: VegaTooltipElementAppenderController;
@@ -21,18 +24,24 @@ export declare class VegaTooltip {
    * Determines the fixed size (width) of the tooltip.
    *
    * It can be provided as a number or a ResponsiveType.
+   *
+   * @version 1.3.0
    */
   size: ResponsiveType<SizeType>;
   /**
    * Determines the minimum width of the tooltip.
    *
    * It can be provided as a number or a ResponsiveType.
+   *
+   * @version 1.30.0
    */
   minWidth: ResponsiveType<SizeType>;
   /**
    * Determines the maximum width of the tooltip.
    *
    * It can be provided as a number or a ResponsiveType.
+   *
+   * @version 1.30.0
    */
   maxWidth: ResponsiveType<SizeType>;
   /**
@@ -40,6 +49,8 @@ export declare class VegaTooltip {
    * - click: means the tooltip show/hide by click.
    * - hover: means the tooltip show/hide by hover.
    * - none: means tooltip is not displayed regardless of hover or click.
+   *
+   * @version 1.3.0
    */
   trigger: 'hover' | 'click' | 'none';
   watchTrigger(): void;
@@ -47,21 +58,29 @@ export declare class VegaTooltip {
    * Specifies the content that is displayed
    *    inside the tooltip.
    * @deprecated This property will be removed soon and replaced by prop text
+   *
+   * @version 1.3.0
    */
   content: string;
   /**
    * Specifies the text that is displayed
    *    inside the tooltip.
+   *
+   * @version 2.0.0
    */
   text: string;
   /**
    * Specifies the vertical positioning of the tooltip
    *    within its container or relative to a reference point.
+   *
+   * @version 1.3.0
    */
   placement: ElementAppenderPlacementType;
   /**
    * Determines the horizontal positioning of the tooltip
    *    within its container or relative to a reference point.
+   *
+   * @version 1.41.0
    */
   alignment: ElementAppenderAlignmentType;
   watchToShowTooltip(): void;
@@ -71,11 +90,15 @@ export declare class VegaTooltip {
    * If not provided, the popup will be appended to the
    *    body by default. Adjust this property if you
    *    encounter scrolling or positioning issues.
+   *
+   * @version 1.3.0
    */
   positionRelativeTo: string;
   /**
    * The tooltip is interactive by default.
    * Set `disableInteractive` to `true` to deactivate this feature, causing the tooltip to close upon hover.
+   *
+   * @version 1.52.0
    */
   disableInteractive: boolean;
   render(): VegaTooltip;

package/dist/types/components/vega-virtual-scroll/vega-virtual-scroll.d.ts

@@ -6,6 +6,9 @@ import { VegaVirtualScrollRenderer } from './slimmers/renderers/vega-virtual-scr
 import { VegaVirtualScrollModeController } from './slimmers/controllers/vega-virtual-scroll-mode-controller';
 import { VegaVirtualScrollLoadingIndicatorRenderer } from './slimmers/renderers/vega-virtual-scroll-loading-indicator-renderer';
 import { VegaComponentUsageRuntimeMetricsSlimmer } from '../../helpers/slimmers/component-usage-runtime-metrics';
+/**
+ * @version 1.13.0
+ */
 export declare class VegaVirtualScroll {
   protected readonly globalSlimmers: GlobalSlimmers;
   protected readonly modeController: VegaVirtualScrollModeController;
@@ -19,26 +22,38 @@ export declare class VegaVirtualScroll {
   positionConfig: VirtualScrollPositionConfig;
   scrollTop: number;
   watchScrollTop(): void;
-  /** The all items of source */
+  /** The all items of source *
+   * @version 1.13.0
+   */
   source: SourceItemType[];
   watchSourceChange(newValue: SourceItemType[], oldValue: SourceItemType[]): void;
-  /** The approximate height of each item */
+  /** The approximate height of each item *
+   * @version 1.13.0
+   */
   approxItemHeight: number;
   watchApproxItemHeight(): void;
-  /** The max height of viewport */
+  /** The max height of viewport *
+   * @version 1.13.0
+   */
   viewportMaxHeight: number;
   watchViewportMaxHeight(): void;
   /**
    * Determines whether the dropdown displays a loading status.
+   *
+   * @version 2.3.0
    */
   isLoading: boolean;
   /**
    * The count of the source that will be used as the threshold for determining whether to use virtual scrolling.
    * If the count of source exceeds this threshold, we employ virtual scrolling. Otherwise, normal item rendering is used
+   *
+   * @version 2.3.0
    */
   virtualizationThreshold: number;
   watchVirtualizationThreshold(): void;
-  /** We set this key to check the source is really change and should refresh virtual scroll */
+  /** We set this key to check the source is really change and should refresh virtual scroll *
+   * @version 1.26.0
+   */
   sourceItemIdentifier: string;
   /**
    * The method of render item.
@@ -46,11 +61,15 @@ export declare class VegaVirtualScroll {
    * example: <vega-virtual-scroll renderItem={this.renderSourceItem.bind(this)}></vega-virtual-scroll> .
    * You should watch the fixHeight, if it have value, you should set {height: `${fixHeight}px`, boxSizing: 'border-box', overflow: 'hidden'} to you item,
    * otherwise, you can do nothing.
+   *
+   * @version 1.13.0
    */
   renderItem: (item: SourceItemType, index?: number, fixHeight?: number) => HTMLElement;
   /**
    * Scroll to the index of the item in the list by setting the scrollTop property of the virtual scroll
    * container to the index of the item multiplied by the approximate height of each item in the list.
+   *
+   * @version 1.13.0
    */
   scrollToIndex(index: number): Promise<void>;
   render(): VegaVirtualScroll;