@globalpayments/vega 2.24.0 → 2.24.2

package/dist/types/components/vega-app-header-button/vega-app-header-button.d.ts

@@ -8,6 +8,9 @@ import { ChildNodesEventPreventSlimmer } from '../../helpers/event-manager/slimm
 import { EventEmitSlimmerBase } from '../../helpers/event-manager/slimmers/event-emit-slimmer';
 import { VegaMenuArrowIconRenderer } from './slimmers/renderers/vega-menu-arrow-icon-renderer';
 import { VegaComponentUsageRuntimeMetricsSlimmer } from '../../helpers/slimmers/component-usage-runtime-metrics';
+/**
+ * @version 1.11.0
+ */
 export declare class VegaAppHeaderButton {
   protected readonly globalSlimmers: GlobalSlimmers;
   /**
@@ -31,25 +34,35 @@ export declare class VegaAppHeaderButton {
   /**
    * Specifies the configuration for the dropdown functionality
    *    of the app header button.
+   *
+   * @version 1.11.0
    */
   dropdown: VegaAppHeaderButtonDropdownConfig;
   /**
    * Specifies the size of the app header button.
+   *
+   * @version 1.11.0
    */
   size: ResponsiveType<VegaAppHeaderButtonSize>;
   /**
    * Specifies the label or text content of the app header button.
+   *
+   * @version 1.11.0
    */
   label: string;
   /**
    * Determines whether to display the label of the app header button
    *    directly on the button itself or in a tooltip
    *    when the user hovers over the button.
+   *
+   * @version 1.11.0
    */
   showLabel: boolean;
   /**
    * Specifies the configuration for the avatar image or icon
    *    displayed in the app header button.
+   *
+   * @version 1.11.0
    */
   avatar: VegaAppHeaderAvatarConfig;
   /**
@@ -60,33 +73,46 @@ export declare class VegaAppHeaderButton {
   /**
    * Specifies the position of the avatar in relation to the label
    *    within the app header button.
+   *
+   * @version 1.11.0
    */
   avatarPosition: 'right' | 'left';
   /**
    * Specifies whether to show a border around the app header button.
+   *
+   * @version 1.11.0
    */
   showBorder: boolean;
   /**
    * Specifies whether to display a menu arrow icon in the app header button.
+   *
+   * @version 1.11.0
    */
   showMenuArrowIcon: boolean;
   /**
    * Specifies whether the app header button is displayed in a selected state.
+   *
+   * @version 1.15.0
    */
   selected: boolean;
   /**
    * An event emitter notifying the click event of an app header button.
+   *
+   * @version 1.11.0
    */
   vegaClick: EventEmitter;
   /**
    * An event emitter notifying the click event of an app header button.
    *
    * @eventSemantics namespace:native
+   * @version 2.0.0
    */
   click: EventEmitter;
   /**
    * An event emitter notifying the click event of a dropdown item
    *    in the app header.
+   *
+   * @version 1.23.0
    */
   vegaDropdownClick: EventEmitter<string>;
   /**
@@ -94,6 +120,7 @@ export declare class VegaAppHeaderButton {
    *    in the app header.
    *
    * @eventSemantics namespace:native
+   * @version 2.0.0
    */
   dropdownClick: EventEmitter<string>;
   render(): VegaAppHeaderButton;

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

@@ -3,6 +3,9 @@ import { GlobalSlimmers } from '../../vega-slimmer/vega-slimmer-core';
 import { VegaBackdropVisibleController } from './slimmers/controller/vega-backdrop-visible-controller';
 import { VegaBackdropRenderer } from './slimmers/renerers/vega-backdrop-renderer';
 import { VegaComponentUsageRuntimeMetricsSlimmer } from '../../helpers/slimmers/component-usage-runtime-metrics';
+/**
+ * @version 2.0.0
+ */
 export declare class VegaBackdrop {
   protected readonly globalSlimmers: GlobalSlimmers;
   protected readonly vegaBackdropVisibleController: VegaBackdropVisibleController;
@@ -11,19 +14,27 @@ export declare class VegaBackdrop {
   host: HTMLVegaBackdropElement;
   /**
    * Defines the color of the backdrop element.
+   *
+   * @version 2.0.0
    */
   color: 'bg-backdrop-modal' | 'bg-backdrop-popover' | 'bg-transparent';
   /**
    * Whether to show or hide the backdrop
+   *
+   * @version 2.0.0
    */
   visible: boolean;
   watchVisible(): void;
   /**
    * The duration of the animation in milliseconds.
+   *
+   * @version 2.0.0
    */
   duration: number;
   /**
    * An event emitter notifying the click event of the backdrop.
+   *
+   * @version 2.0.0
    */
   vegaClick: EventEmitter<void>;
   render(): VegaBackdrop;

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

@@ -6,6 +6,9 @@ import { VegaBannerIconController } from './slimmers/controllers/vega-banner-ico
 import { VegaBannerActionButtonRenderer } from './slimmers/renderers/vega-banner-action-button-renderer';
 import { EventEmitSlimmerBase } from '../../helpers/event-manager/slimmers/event-emit-slimmer';
 import { VegaComponentUsageRuntimeMetricsSlimmer } from '../../helpers/slimmers/component-usage-runtime-metrics';
+/**
+ * @version 1.9.1
+ */
 export declare class VegaBanner {
   protected readonly globalSlimmers: GlobalSlimmers;
   protected closeEventEmitter: EventEmitSlimmerBase;
@@ -17,52 +20,72 @@ export declare class VegaBanner {
   host: HTMLVegaBannerElement;
   /**
    * Specifies the type of the banner.
+   *
+   * @version 2.8.0
    */
   type: VegaBannerPropType;
   /**
    * Specifies the label or title for the banner.
+   *
+   * @version 2.8.0
    */
   bannerTitle: string;
   /**
    * Specifies the content displayed within the banner.
+   *
+   * @version 2.8.0
    */
   content: string;
   /**
    * Specifies the action buttons available within the banner.
    *    These buttons enable users to perform specific actions,
    *    enhancing user interaction within the banner.
+   *
+   * @version 2.8.0
    */
   actionButtons: VegaBannerActionButtonType[];
   /**
    * Determines whether the close icon is displayed.
+   *
+   * @version 1.13.0
    */
   showCloseButton: boolean;
   /**
    * Determines whether the banner is displayed.
+   *
+   * @version 2.13.0
    */
   isOpen: boolean;
   /**
    * An event emitter notifying the banner close event.
+   *
+   * @version 1.13.0
    */
   vegaClose: EventEmitter;
   /**
    * An event emitter notifying the banner close event.
    *
    * @eventSemantics namespace:native
+   * @version 2.8.0
    */
   close: EventEmitter;
   /**
    * An event emitter notifying the banner action button has been clicked.
+   *
+   * @version 2.18.0
    */
   vegaActionButtonClick: EventEmitter<VegaBannerActionButtonType>;
   /**
    * An event emitter notifying the banner action button has been clicked.
    *
    * @eventSemantics namespace:native
+   * @version 2.18.0
    */
   actionButtonClick: EventEmitter<VegaBannerActionButtonType>;
   /**
    * Invoke this method to close the banner.
+   *
+   * @version 2.8.0
    */
   doClose(): Promise<void>;
   render(): VegaBanner;

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

@@ -5,6 +5,9 @@ import { BackgroundColorsTokenType, BorderColorsTokenType, BordersTokenType, Bre
 import { PageResizeObserverSlimmer } from '../../helpers/slimmers/page-resize-observer-slimmer';
 import { AlignSelfType, FlexBasisType, FlexGrowType, FlexShrinkType, FlexType, JustifySelfType, OrderType, GridAreaType, GridColumnType, GridRowType } from './interface';
 import { VegaComponentUsageRuntimeMetricsSlimmer } from '../../helpers/slimmers/component-usage-runtime-metrics';
+/**
+ * @version 1.27.0
+ */
 export declare class VegaBox {
   protected readonly globalSlimmers: GlobalSlimmers;
   protected readonly pageResizeSlimmer: PageResizeObserverSlimmer;
@@ -25,6 +28,8 @@ export declare class VegaBox {
    * Note that the `default` value is required when using a responsive map
    *    to provide a fallback padding value for breakpoints
    *    that are not explicitly defined.
+   *
+   * @version 1.27.0
    */
   padding: ResponsiveType<PaddingType>;
   /**
@@ -41,26 +46,36 @@ export declare class VegaBox {
    * Note that the `default` value is required when using a responsive map
    *    to provide a fallback margin value for breakpoints
    *    that are not explicitly defined.
+   *
+   * @version 1.27.0
    */
   margin: ResponsiveType<MarginType>;
   /**
    * Defines the display behavior of the box, allowing you to choose from
    *    standard display options like `block` and `none`.
+   *
+   * @version 1.38.0
    */
   display: ResponsiveType<BoxDisplayType>;
   /**
    * Defines the border of the box.
    *    It accepts a string value representing a valid
    *    border token.
+   *
+   * @version 2.0.0
    */
   border: StateVariantType<BordersTokenType, CssStatesType>;
   watchBorder(): void;
-  /** Specifies the line style of the box border. */
+  /** Specifies the line style of the box border. *
+   * @version 2.7.0
+   */
   borderStyle: BorderStyleType;
   /**
    * Defines the box shadow of the box.
    *    It accepts a string value representing a valid
    *    box shadow token.
+   *
+   * @version 2.0.0
    */
   shadow: StateVariantType<ShadowsTokenType, 'default' | 'focus-visible' | 'hover'>;
   watchShadow(): void;
@@ -68,6 +83,8 @@ export declare class VegaBox {
    * Defines the border color of the box.
    *    It accepts a string value representing a valid
    *    border color token.
+   *
+   * @version 2.0.0
    */
   borderColor: StateVariantType<BorderColorsTokenType, CssStatesType>;
   watchBorderColor(): void;
@@ -75,6 +92,8 @@ export declare class VegaBox {
    * Defines the background color of the box.
    *    It accepts a string value representing a valid
    *    background color token.
+   *
+   * @version 2.0.0
    */
   backgroundColor: StateVariantType<BackgroundColorsTokenType, CssStatesType>;
   watchBackgroundColor(): void;
@@ -87,6 +106,8 @@ export declare class VegaBox {
    *    For example, '100%' and 'calc(100vw - 20px)' which allows for more complex calculations to
    *    determine the width.
    * For spacing tokens, you can set 'size-2', 'size-16' and etc. Please refer to https://vega.hlprd.com/tokens/spacing to check the full list of spacing tokens.
+   *
+   * @version 2.0.0
    */
   width: ResponsiveType<WidthType>;
   /**
@@ -98,6 +119,8 @@ export declare class VegaBox {
    *    For example, '100%' and 'calc(100vh - 20px)' which allows for more complex calculations to
    *    determine the height.
    * For spacing tokens, you can set 'size-2', 'size-16' and etc. Please refer to https://vega.hlprd.com/tokens/spacing to check the full list of spacing tokens.
+   *
+   * @version 2.0.0
    */
   height: ResponsiveType<HeightType>;
   /**
@@ -111,6 +134,8 @@ export declare class VegaBox {
    * Spacing tokens like 'size-2' or 'size-16' can also be used.
    *    Please refer to https://vega.hlprd.com/tokens/spacing
    *    to check the full list of spacing tokens.
+   *
+   * @version 2.7.0
    */
   minHeight: ResponsiveType<MinHeightType>;
   /**
@@ -124,56 +149,82 @@ export declare class VegaBox {
    * Spacing tokens like 'size-2' or 'size-16' can also be used.
    *    Please refer to https://vega.hlprd.com/tokens/spacing
    *    to check the full list of spacing tokens.
+   *
+   * @version 2.7.0
    */
   maxHeight: ResponsiveType<MaxHeightType>;
   /**
    * Defines the custom class name of the box.
+   *
+   * @version 2.0.0
    */
   responsiveClass: ResponsiveType<string>;
   /**
    * Defines the corner of the box.
    *    It accepts a string value representing a valid
    *    border radius token.
+   *
+   * @version 2.0.0
    */
   corners: ResponsiveType<CornersType>;
   /**
    * Specifies the base size of the box.
+   *
+   * @version 2.3.0
    */
   flexBasis: ResponsiveType<FlexBasisType>;
   /**
    * Specifies how the box is grow.
+   *
+   * @version 2.3.0
    */
   flexGrow: ResponsiveType<FlexGrowType>;
   /**
    * Specifies how much the box shrinks.
+   *
+   * @version 2.3.0
    */
   flexShrink: ResponsiveType<FlexShrinkType>;
   /**
    * Specifies the display order of the box.
+   *
+   * @version 2.3.0
    */
   order: ResponsiveType<OrderType>;
   /**
    * Specifies how the box adjusts its size, growth, and alignment within a flex container.
+   *
+   * @version 2.3.0
    */
   flex: ResponsiveType<FlexType>;
   /**
    * Specifies how the box aligns itself within its container.
+   *
+   * @version 2.3.0
    */
   alignSelf: ResponsiveType<AlignSelfType>;
   /**
    * Specifies how a single box justifies its content along the main axis within its container.
+   *
+   * @version 2.3.0
    */
   justifySelf: ResponsiveType<JustifySelfType>;
   /**
    * Determines the placement of the item within the grid along the horizontal axis.
+   *
+   * @version 2.5.0
    */
   gridColumn: ResponsiveType<GridColumnType>;
   /**
    * Determines the placement of the item within the grid along the vertical axis.
+   *
+   * @version 2.5.0
    */
   gridRow: ResponsiveType<GridRowType>;
   /**
    * Defines the area within the grid occupied by the item. It accepts CSS values and can be set as ResponsiveType.
+   *
+   * @version 2.5.0
    */
   gridArea: ResponsiveType<GridAreaType>;
   render(): VegaBox;

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

@@ -8,6 +8,9 @@ import { VegaBreadcrumbClickController } from './slimmers/controllers/vega-bread
 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.41.0
+ */
 export declare class VegaBreadcrumb {
   protected readonly globalSlimmers: GlobalSlimmers;
   protected readonly renderer: VegaBreadcrumbRenderer;
@@ -28,19 +31,26 @@ export declare class VegaBreadcrumb {
    * If you set this value to `none`, all items will remain expanded.
 
    * The minimum allowed value for this property is 4.
+   *
+   * @version 1.41.0
    */
   maxItems: VegaBreadcrumbCollapsedThresholdType;
   /**
    * Represents the individual elements within the `vega-breadcrumb` component.
+   *
+   * @version 1.41.0
    */
   items: VegaBreadcrumbItemType[];
   /**
    * An event emitter notifying that a breadcrumb item has been clicked.
+   *
+   * @version 1.41.0
    */
   vegaClick: EventEmitter<VegaBreadcrumbItemType>;
   /**
    * An event emitter notifying that a breadcrumb item has been clicked.
    * @eventSemantics namespace:native
+   * @version 2.0.0
    */
   click: EventEmitter<VegaBreadcrumbItemType>;
   render(): VegaBreadcrumb;

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

@@ -8,6 +8,9 @@ import { EventEmitSlimmerBase } from '../../helpers/event-manager/slimmers/event
 import { ChildNodesEventPreventSlimmer } from '../../helpers/event-manager/slimmers/child-nodes-event-prevent-slimmer';
 import { VegaComponentUsageRuntimeMetricsSlimmer } from '../../helpers/slimmers/component-usage-runtime-metrics';
 import { VegaButtonLoadingRenderer } from './slimmers/renderers/vega-button-loading-renderer';
+/**
+ * @version 1.0.0
+ */
 export declare class VegaButton {
   protected readonly globalSlimmers: GlobalSlimmers;
   /**
@@ -23,61 +26,84 @@ export declare class VegaButton {
   currentBreakpoint: BreakpointsTokenType;
   /**
    * Specifies the size of the button.
+   *
+   * @version 1.0.0
    */
   size: ResponsiveType<VegaButtonSize>;
   /**
    * Specifies the visual style and prominence of the button.
    *
    * It determines how the button will be presented to the user.
+   *
+   * @version 1.0.0
    */
   variant: VegaButtonVariant;
   /**
    * Specifies the icon to be displayed on the button,
    *    which can be selected from a list of predefined icon tokens
    *    or specified using a Font Awesome class.
+   *
+   * @version 1.0.3
    */
   icon: string;
   /**
    * Specifies the placement of the icon in relation to the button's label.
+   *
+   * @version 1.3.0
    */
   iconAlign: VegaButtonIconAlign;
   /**
    * Specifies the text displayed on the button.
+   *
+   * @version 1.0.3
    */
   label: string;
   /**
    * Specifies whether the button element is disabled.
+   *
+   * @version 1.0.3
    */
   disabled: boolean;
   /**
    * Indicates the danger status of the button,
    *    typically used for destructive actions.
+   *
+   * @version 1.3.0
    */
   danger: boolean;
   /**
    * Specifies whether the button should span the
    *    full width of its parent element.
+   *
+   * @version 1.3.0
    */
   block: ResponsiveType<boolean>;
   /**
    * Specifies the type of button and its behavior in relation to
    *    form submission and data reset.
+   *
+   * @version 1.0.3
    */
   type: VegaButtonType;
   /**
    * Specifies whether the button is in a loading state. When `true`,
    *     the button is disabled and an indeterminate loading indicator
    *     is displayed within the button.
+   *
+   * @version 2.17.0
    */
   loading: boolean;
   /**
    * An event emitter notifying the click event of the button.
+   *
+   * @version 1.0.11
    */
   vegaClick: EventEmitter;
   /**
    * An event emitter notifying the click event of the button.
    *
    * @eventSemantics namespace:native
+   * @version 2.0.0
    */
   click: EventEmitter;
   componentWillLoad(): void;

package/dist/types/components/vega-button-circle/vega-button-circle.d.ts

@@ -6,6 +6,9 @@ import { GlobalSlimmers } from '../../vega-slimmer/vega-slimmer-core';
 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.0.2
+ */
 export declare class VegaButtonCircle {
   protected readonly globalSlimmers: GlobalSlimmers;
   protected clickEventEmitter: EventEmitSlimmerBase;
@@ -14,6 +17,8 @@ export declare class VegaButtonCircle {
   host: HTMLVegaButtonCircleElement;
   /**
    * Specifies the size of the circular button.
+   *
+   * @version 1.0.2
    */
   size: VegaButtonCircleSize;
   /**
@@ -30,53 +35,74 @@ export declare class VegaButtonCircle {
    * - `icon-only`:
    *      The circular button is rendered with an icon displayed in the default state,
    *      and the circle background appears when hovering over the button.
+   *
+   * @version 1.0.2
    */
   variant: VegaButtonCircleVariant;
   /**
    * Specifies the icon to be displayed on the circular button,
    *    which can be selected from a list of predefined icon tokens
    *    or specified using a Font Awesome class.
+   *
+   * @version 1.0.4
    */
   icon: string;
   /**
    * Specifies the text to be displayed in the tooltip for the circular button
    *    and sets it as the `aria-label` for accessibility.
+   *
+   * @version 1.0.4
    */
   label: string;
   /**
    * Specifies whether the circular button element is disabled.
+   *
+   * @version 1.0.4
    */
   disabled: boolean;
   /**
    * Indicates the danger status of the circular button,
    *    typically used for destructive actions.
+   *
+   * @version 1.3.0
    */
   danger: boolean;
   /**
    * Specifies the type of button and its behavior in relation to
    *    form submission and data reset.
+   *
+   * @version 1.16.0
    */
   type: VegaButtonType;
   /**
    * Specifies the color of the icon displayed on the circular button.
+   *
+   * @version 1.24.0
    */
   iconColor: TextColorsTokenType;
   /**
    * Indicates whether to use a tooltip to display the label for the button circle.
+   *
+   * @version 2.0.0
    */
   showTooltip: boolean;
   /**
    * Specifies the properties of the tooltip displayed for the button circle.
+   *
+   * @version 1.52.0
    */
   tooltip: VegaButtonCircleTooltip;
   /**
    * An event emitter notifying the click event of the circular button.
+   *
+   * @version 1.0.11
    */
   vegaClick: EventEmitter;
   /**
    * An event emitter notifying the click event of the circular button.
    *
    * @eventSemantics namespace:native
+   * @version 2.0.0
    */
   click: EventEmitter;
   componentWillLoad(): void;

package/dist/types/components/vega-button-group/vega-button-group-item/vega-button-group-item.d.ts

@@ -4,6 +4,9 @@ import { VegaButtonGroupItemSubStateController } from './slimmers/controllers/ve
 import { DropdownSourceGroup, DropdownSourceItem } from '../../vega-dropdown/types';
 import { VegaButtonGroupItemRenderer } from './slimmers/renderers/vega-button-group-item-renderer';
 import { VegaComponentUsageRuntimeMetricsSlimmer } from '../../../helpers/slimmers/component-usage-runtime-metrics';
+/**
+ * @version 2.5.0
+ */
 export declare class VegaButtonGroupItem {
   protected readonly globalSlimmers: GlobalSlimmers;
   protected subStateObserverSlimmer: VegaButtonGroupItemSubStateController;
@@ -17,26 +20,38 @@ export declare class VegaButtonGroupItem {
    * Specifies the icon to be displayed on the button item,
    *    which can be selected from a list of predefined icon tokens
    *    or specified using a Font Awesome class.
+   *
+   * @version 2.5.0
    */
   icon: string;
   /**
    * Specifies the text displayed on the button item.
+   *
+   * @version 2.5.0
    */
   label: string;
   /**
    * Specifies whether to display the icon only.
+   *
+   * @version 2.5.0
    */
   iconOnly: boolean;
   /**
    * Specifies the unique key for the button item.
+   *
+   * @version 2.5.0
    */
   itemKey: string;
   /**
    * Specifies the properties for the dropdown menu that appears when the button group contains more than one button item.
+   *
+   * @version 2.5.0
    */
   dropdownProps: DropdownPropsForButtonGroup;
   /**
    * Defines the data source used to populate the dropdown menu when the button group contains more than one button item.
+   *
+   * @version 2.5.0
    */
   dropdownSource: (DropdownSourceGroup | DropdownSourceItem)[];
   render(): VegaButtonGroupItem;