@globalpayments/vega 2.14.0 → 2.16.0

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

@@ -0,0 +1,41 @@
+import { GlobalSlimmers } from '../../vega-slimmer/vega-slimmer-core';
+import { VegaComponentUsageRuntimeMetricsSlimmer } from '../../helpers/slimmers/componentUsageRuntimeMetrics';
+import { VegaSkeletonTextRenderer } from './slimmers/renderers/vega-skeleton-text-renderer';
+import { VegaSkeletonParagraphRenderer } from './slimmers/renderers/vega-skeleton-paragraph-renderer';
+import { VegaSkeletonFullWidthParagraphRenderer } from './slimmers/renderers/vega-skeleton-full-width-paragraph-renderer';
+import { VegaSkeletonImageRenderer } from './slimmers/renderers/vega-skeleton-image-renderer';
+import { VegaSkeletonTableRenderer } from './slimmers/renderers/vega-skeleton-table-renderer';
+import { VegaSkeletonRendererManager } from './slimmers/renderers/vega-skeleton-renderer-manager';
+import { VegaSkeletonEllipseRenderer } from './slimmers/renderers/vega-skeleton-ellipse-renderer';
+import { HeightType, WidthType } from '../../types/ui.type';
+import { VegaSkeletonType } from './interface';
+export declare class VegaSkeleton {
+  protected readonly globalSlimmers: GlobalSlimmers;
+  protected vegaComponentUsageRuntimeMetricsSlimmer: VegaComponentUsageRuntimeMetricsSlimmer<HTMLVegaSkeletonElement>;
+  protected vegaSkeletonTextRenderer: VegaSkeletonTextRenderer;
+  protected vegaSkeletonParagraphRenderer: VegaSkeletonParagraphRenderer;
+  protected vegaSkeletonFullWidthParagraphRenderer: VegaSkeletonFullWidthParagraphRenderer;
+  protected vegaSkeletonEllipseRenderer: VegaSkeletonEllipseRenderer;
+  protected vegaSkeletonImageRenderer: VegaSkeletonImageRenderer;
+  protected vegaSkeletonTableRenderer: VegaSkeletonTableRenderer;
+  protected vegaSkeletonRendererManager: VegaSkeletonRendererManager;
+  host: HTMLVegaSkeletonElement;
+  /**
+   * Specifies the type of the skeleton.
+   */
+  type: VegaSkeletonType;
+  /**
+   * Specifies the width of the skeleton.
+   */
+  width: WidthType;
+  /**
+   * Specifies the height of the skeleton.
+   * - This property is applicable only when {@link type} is set to is `image` or `ellipse`.
+   */
+  height: HeightType;
+  /**
+   * Indicates whether the skeleton displays an animation effect.
+   */
+  animated: boolean;
+  render(): VegaSkeleton;
+}

package/dist/types/components/vega-tab-group/slimmers/vega-tab-group/controllers/vega-tab-group-selected-target-controller.d.ts

@@ -5,15 +5,15 @@ export declare class VegaTabGroupSelectedTargetController extends VegaSlimmer {
   clickEventEmitter: VegaTabGroup['clickEventEmitter'];
   selectedTabDataTarget: VegaTabGroup['selectedTabDataTarget'];
   /**
-   * The function will call when component call selectedTabDataTargetChange function and emit a vega click event
+   * The function sets the selectedTabDataTarget property to the provided dataTarget value.
    *
-   * {@link VegaTabGroup#watchSelectedTabDataTargetChange}
+   * @param {string} dataTarget - The dataTarget parameter is a string that represents the target data for the selected tab.
    */
-  handleSelectedDataTargetChange(): void;
+  setSelectedDataTarget(dataTarget: string): void;
   /**
-   * The function sets the selectedTabDataTarget property to the provided dataTarget value.
+   * The function emits click event and checks for prevent default then sets the selectedTabDataTarget property to the provided dataTarget value.
    *
    * @param {string} dataTarget - The dataTarget parameter is a string that represents the target data for the selected tab.
    */
-  setSelectedDataTarget(dataTarget: string): void;
+  handleTabItemClick(dataTarget: string): void;
 }

package/dist/types/components/vega-tab-group/slimmers/vega-tab-group/renderers/vega-tab-group-tab-list-renderer.d.ts

@@ -20,5 +20,5 @@ export declare class VegaTabGroupTabListRenderer extends VegaSlimmer {
   private renderTabList;
   private renderPrefixIconDom;
   private renderTabLabelDom;
-  private tabItemClick;
+  private handleTabItemClick;
 }

package/dist/types/components.d.ts

@@ -42,6 +42,7 @@ import { VegaPageNotificationActionButtonConfig, VegaPageNotificationTypes } fro
 import { VegaPaginationItemType } from "./components/vega-pagination/types";
 import { PieChartOptions } from "./helpers/chart/pieChart";
 import { VegaSegmentControlVariant, VegaSegmentProps } from "./components/vega-segment-control/types";
+import { VegaSkeletonType } from "./components/vega-skeleton/interface";
 import { TabConfig, TabGroupVariant } from "./components/vega-tab-group/types";
 import { VegaTableChangePropType, VegaTableColumnBreakpoint, VegaTableColumnConfig, VegaTableDataSourceItem, VegaTableDensityType, VegaTableHeadCellClickEvent, VegaTablePagination, VegaTableRowClickEvent, VegaTableRowClickPropType, VegaTableRowSelectionConfig, VegaTableRowSelectProp, VegaTableScrollConfig, VegaTableSelectAllProp, VegaTableSorterConfig, VegaTableSortOrderType } from "./components/vega-table/interface";
 import { VegaTextTooltipProps } from "./components/vega-text/types";
@@ -2082,6 +2083,24 @@ export namespace Components {
          */
         "value": string | string[];
     }
+    interface VegaSkeleton {
+        /**
+          * Indicates whether the skeleton displays an animation effect.
+         */
+        "animated": boolean;
+        /**
+          * Specifies the height of the skeleton. - This property is applicable only when {@link type} is set to is `image` or `ellipse`.
+         */
+        "height": HeightType;
+        /**
+          * Specifies the type of the skeleton.
+         */
+        "type": VegaSkeletonType;
+        /**
+          * Specifies the width of the skeleton.
+         */
+        "width": WidthType;
+    }
     interface VegaSlotContainer {
     }
     interface VegaStepper {
@@ -3174,6 +3193,12 @@ declare global {
         prototype: HTMLVegaSelectionTileGroupElement;
         new (): HTMLVegaSelectionTileGroupElement;
     };
+    interface HTMLVegaSkeletonElement extends Components.VegaSkeleton, HTMLStencilElement {
+    }
+    var HTMLVegaSkeletonElement: {
+        prototype: HTMLVegaSkeletonElement;
+        new (): HTMLVegaSkeletonElement;
+    };
     interface HTMLVegaSlotContainerElement extends Components.VegaSlotContainer, HTMLStencilElement {
     }
     var HTMLVegaSlotContainerElement: {
@@ -3361,6 +3386,7 @@ declare global {
         "vega-segment-control": HTMLVegaSegmentControlElement;
         "vega-selection-tile": HTMLVegaSelectionTileElement;
         "vega-selection-tile-group": HTMLVegaSelectionTileGroupElement;
+        "vega-skeleton": HTMLVegaSkeletonElement;
         "vega-slot-container": HTMLVegaSlotContainerElement;
         "vega-stepper": HTMLVegaStepperElement;
         "vega-tab-group": HTMLVegaTabGroupElement;
@@ -5817,6 +5843,24 @@ declare namespace LocalJSX {
          */
         "value"?: string | string[];
     }
+    interface VegaSkeleton {
+        /**
+          * Indicates whether the skeleton displays an animation effect.
+         */
+        "animated"?: boolean;
+        /**
+          * Specifies the height of the skeleton. - This property is applicable only when {@link type} is set to is `image` or `ellipse`.
+         */
+        "height"?: HeightType;
+        /**
+          * Specifies the type of the skeleton.
+         */
+        "type"?: VegaSkeletonType;
+        /**
+          * Specifies the width of the skeleton.
+         */
+        "width"?: WidthType;
+    }
     interface VegaSlotContainer {
     }
     interface VegaStepper {
@@ -6409,6 +6453,7 @@ declare namespace LocalJSX {
         "vega-segment-control": VegaSegmentControl;
         "vega-selection-tile": VegaSelectionTile;
         "vega-selection-tile-group": VegaSelectionTileGroup;
+        "vega-skeleton": VegaSkeleton;
         "vega-slot-container": VegaSlotContainer;
         "vega-stepper": VegaStepper;
         "vega-tab-group": VegaTabGroup;
@@ -6501,6 +6546,7 @@ declare module "@stencil/core" {
             "vega-segment-control": LocalJSX.VegaSegmentControl & JSXBase.HTMLAttributes<HTMLVegaSegmentControlElement>;
             "vega-selection-tile": LocalJSX.VegaSelectionTile & JSXBase.HTMLAttributes<HTMLVegaSelectionTileElement>;
             "vega-selection-tile-group": LocalJSX.VegaSelectionTileGroup & JSXBase.HTMLAttributes<HTMLVegaSelectionTileGroupElement>;
+            "vega-skeleton": LocalJSX.VegaSkeleton & JSXBase.HTMLAttributes<HTMLVegaSkeletonElement>;
             "vega-slot-container": LocalJSX.VegaSlotContainer & JSXBase.HTMLAttributes<HTMLVegaSlotContainerElement>;
             "vega-stepper": LocalJSX.VegaStepper & JSXBase.HTMLAttributes<HTMLVegaStepperElement>;
             "vega-tab-group": LocalJSX.VegaTabGroup & JSXBase.HTMLAttributes<HTMLVegaTabGroupElement>;

package/dist/types/helpers/event-manager/slimmers/childNodesEventPreventSlimmer.d.ts

@@ -70,5 +70,11 @@ export declare class ChildNodesEventPreventSlimmer extends VegaSlimmer {
    * @param {CustomEvent} event event object
    */
   private preventChildEvent;
+  /**
+   * The function `shouldSkipEventPrevent` checks if a host element has a specific dataset value to determine whether event prevention should be skipped.
+   *
+   * @returns {boolean} If the `hostElement` exists and has a `dataset.vegaNoEventPrevent` attribute with a value of `'true'`, then the function returns `true`. Otherwise, it returns `false`.
+   */
+  private shouldSkipEventPrevent;
 }
 export {};

package/dist/types/helpers/formatter/responsive-map-formatter/responsiveWidthAndHeightFormatter.d.ts

@@ -16,18 +16,6 @@ export declare class ResponsiveWidthAndHeightFormatter implements ResponsiveForm
    * @returns {string} The `format` function returns a string value.
    */
   format(input: ResponsiveType<WidthType | HeightType>): string;
-  /**
-   * The function `formatWidthAndHeight` takes an input of type `WidthType` or `HeightType` and returns a
-   * string representation with 'px' appended if the input is a number or a string that can be converted
-   * to a number, otherwise it returns the input as is.
-   *
-   * @param {WidthType | HeightType} input - The `input` parameter in the `formatWidthAndHeight` function
-   * can be either a `number`, a `string` that can be converted to a number, or a key from the `Spacing`
-   * object.
-   * @returns {string} The `formatWidthAndHeight` function takes an input of type `WidthType` or `HeightType` and
-   * returns a string.
-   */
-  formatWidthAndHeight(input: WidthType | HeightType): string;
 }
 declare const _default: ResponsiveWidthAndHeightFormatter;
 export default _default;

package/dist/types/helpers/publicApi.d.ts

@@ -12,3 +12,4 @@ export { VegaIconManager } from './icon/iconManager';
 export { ValidCreditCardNumberRule } from './validator/rules/validCreditCardNumberRule';
 export { waitForVega } from './common';
 export { IconPayload } from '../helpers/icon/interface';
+export { VegaSkeletonLoader } from '../helpers/skeleton-loader/vega-skeleton-loader-controller';

package/dist/types/helpers/skeleton-loader/interface.d.ts

@@ -0,0 +1,16 @@
+import { VegaComponentInterface } from '../../types/ui.type';
+
+export type VegaSkeletonLoaderItem = Partial<
+	Pick<VegaComponentInterface<HTMLVegaSkeletonElement>, 'type' | 'width' | 'height'>
+>;
+
+export type VegaSkeletonLoaderLayout = {
+	props?: Partial<VegaComponentInterface<HTMLVegaFlexElement>>;
+	style?: Partial<CSSStyleDeclaration>;
+};
+
+export type VegaSkeletonLoaderConfig = {
+	target: string;
+	items?: VegaSkeletonLoaderItem[];
+	layout?: VegaSkeletonLoaderLayout;
+} & VegaSkeletonLoaderItem;

package/dist/types/helpers/skeleton-loader/tests/vega-skeleton-loader-controller.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/helpers/skeleton-loader/vega-skeleton-loader-controller.d.ts

@@ -0,0 +1,48 @@
+import { VegaSkeletonLoaderConfig } from './interface';
+/**
+ * Vega Skeleton Loader Controller to show skeletons in the target elements
+ */
+declare class VegaSkeletonLoaderController {
+  private static readonly LOADER_DATA_SET_KEY;
+  private loaderMap;
+  /**
+   * Load the skeletons in the target elements
+   *
+   * @param { VegaSkeletonLoaderConfig } config - Configuration for the loading function
+   * @param {string} config.target - Target elements to show the skeletons.
+   * @param {VegaSkeletonLoaderConfig.type} [config.type = 'text'] - Type of the skeleton.
+   * @param {VegaSkeletonLoaderConfig.width} config.width - Width of the skeleton.
+   * @param {VegaSkeletonLoaderConfig.height} config.height - Height of the skeleton.
+   * @param {VegaSkeletonLoaderConfig.items} config.items - Configuration for multiple skeleton items.
+   * @param {VegaSkeletonLoaderConfig.layout} config.layout - Layout of the skeleton items.
+   * @returns { string } - Key of the loaded skeleton items.
+   */
+  load({ target, type, width, height, items, layout }: VegaSkeletonLoaderConfig): string;
+  /**
+   * Remove the skeletons from the dom.
+   *
+   * @param {string} key - The key returned from {@link VegaSkeletonLoaderController.load}.
+   */
+  unLoad(key: string): void;
+  /**
+   * Remove all the skeletons from the dom.
+   */
+  unLoadAll(): void;
+  /**
+   * Create a skeleton item. The skeleton animated always be true
+   *
+   * @param {VegaSkeletonLoaderItem} config - Configuration for the skeleton item.
+   * @returns {HTMLElement} - Skeleton item.
+   */
+  private createSkeleton;
+  /**
+   * Wrap the flex layout for the skeletons.
+   *
+   * @param {HTMLElement[]} skeletons - Skeleton elements of the loader.
+   * @param {VegaSkeletonLoaderLayout} layout - Flex properties for the layout.
+   * @returns {HTMLElement} - Container wrapping the skeletons in the specified flex layout.
+   */
+  private wrapLayout;
+}
+export declare const VegaSkeletonLoader: VegaSkeletonLoaderController;
+export {};

package/dist/types/types/components.type.d.ts

@@ -146,6 +146,7 @@ export {
 export { VegaPaginationItemType } from '../components/vega-pagination/types';
 export { PieChartOptions } from '../helpers/chart/pieChart';
 export { VegaSegmentControlVariant, VegaSegmentProps } from '../components/vega-segment-control/types';
+export { VegaSkeletonType } from '../components/vega-skeleton/interface';
 export { TabConfig, TabGroupVariant } from '../components/vega-tab-group/types';
 export {
 	VegaTableChangePropType,

package/dist/types/types/publicApi.d.ts

@@ -13,3 +13,4 @@ export { VegaComponentName, VegaNativeEventNameType } from './ui.type';
 export { VegaLoaderOptions, VegaLoaderIndicatorOptions } from '../helpers/loading-indicator/vegaLoader';
 export { VegaNotifyOption } from '../helpers/notify/vegaNotify';
 export { OverrideColor } from '../helpers/theme/theme';
+export { VegaSkeletonLoaderConfig, VegaSkeletonLoaderLayout, VegaSkeletonLoaderItem, } from '../helpers/skeleton-loader/interface';

package/dist/types/utils/pixel.d.ts

@@ -1,3 +1,4 @@
+import { SpacingTokenType } from '../types/designToken.type';
 /**
  * The function parses a string representing a pixel value to a number, or returns the input if it is already a number.
  *
@@ -17,3 +18,13 @@ export declare function parsePixelStringToNumber(input: number | string): number
  * string, it returns the input string as is.
  */
 export declare function parseNumberToPixelString(input: number | string): string;
+/**
+ * This function takes an input parameter and returns a string.
+ * - If the input is a number, it returns a string with 'px'.
+ * - If the input is a string, it returns the input string as is.
+ * - If the input is a {@link SpacingTokenType}, it returns a parsed value string with 'px'.
+ *
+ * @param {number | string | SpacingTokenType} input - The input parameter can be either a number or a string. If it is a
+ * @returns {string} returns a string that represents a CSS pixel value
+ */
+export declare function parseToPixelString(input: number | string | SpacingTokenType): string;

package/dist/vega/index.esm.js

@@ -1 +1 @@
-export{B as Breakpoints,g as getCurrentBreakpoint}from"./p-3542f8fe.js";export{L as LogUtility,s as setVegaLogLevel}from"./p-018d77cc.js";export{d as formatAndValidBackgroundColor,e as formatAndValidBorderColor,g as formatAndValidBorderRadius,c as formatAndValidBreakpointSize,a as formatAndValidGap,h as formatAndValidPadding,f as formatAndValidResponsiveToken,b as formatAndValidShadow,i as formatAndValidTextColor}from"./p-e4d466f0.js";export{c as camelToDashCase}from"./p-0bb29d98.js";export{d as BackgroundColorMap,a as BackgroundColors,e as BorderColorMap,b as BorderColors,B as BorderRadius,C as Colors,F as FillBackgroundColors,g as ShadowMap,f as Shadows,h as Spacing,S as StrokeBackgroundColors,c as TextColorMap,T as TextColors}from"./p-1265732f.js";export{I as Icons,g as getIconFromToken}from"./p-16493e5b.js";export{a as Typography,b as TypographyKeys,T as TypographyUrls}from"./p-c59042c0.js";export{B as BreakpointKeys}from"./p-3c8b2105.js";export{F as FrameworkEnum,v as VegaEnvManager,c as VegaEventManager,V as VegaLoader,a as VegaNotify,b as VegaThemeManager,w as waitForVega}from"./p-99c8fe92.js";export{F as FeatureFlag}from"./p-f2118771.js";export{V as VegaDialog}from"./p-34964cc9.js";export{B as VegaJQueryDelegatedEventStrategy}from"./p-aae8855d.js";export{V as VegaIconManager}from"./p-9d426517.js";export{V as ValidCreditCardNumberRule}from"./p-8054bb18.js";import"./p-fc21bd44.js";import"./p-344ee7cb.js";import"./p-6bdc4407.js";import"./p-3a0a4d15.js";import"./p-469bc36e.js";import"./p-320642bd.js";import"./p-abf5b8f7.js";import"./p-d3f1d3dd.js";import"./p-cb13b4e6.js";import"./p-112455b1.js";import"./p-61f18887.js";import"./p-f1d8fd1c.js";const o=["ring-input-focus","dark-ring-input-focus","ring-input-danger-focus","dark-ring-input-danger-focus","ring-action-focus","dark-ring-action-focus","ring-action-danger-focus","dark-ring-action-danger-focus"];export{o as Rings}
+export{B as Breakpoints,g as getCurrentBreakpoint}from"./p-3542f8fe.js";export{L as LogUtility,s as setVegaLogLevel}from"./p-018d77cc.js";export{d as formatAndValidBackgroundColor,e as formatAndValidBorderColor,g as formatAndValidBorderRadius,c as formatAndValidBreakpointSize,a as formatAndValidGap,h as formatAndValidPadding,f as formatAndValidResponsiveToken,b as formatAndValidShadow,i as formatAndValidTextColor}from"./p-9e38810c.js";export{c as camelToDashCase}from"./p-0bb29d98.js";export{d as BackgroundColorMap,a as BackgroundColors,e as BorderColorMap,b as BorderColors,B as BorderRadius,C as Colors,F as FillBackgroundColors,g as ShadowMap,f as Shadows,h as Spacing,S as StrokeBackgroundColors,c as TextColorMap,T as TextColors}from"./p-1265732f.js";export{I as Icons,g as getIconFromToken}from"./p-16493e5b.js";export{a as Typography,b as TypographyKeys,T as TypographyUrls}from"./p-c59042c0.js";export{B as BreakpointKeys}from"./p-3c8b2105.js";export{F as FrameworkEnum,v as VegaEnvManager,c as VegaEventManager,V as VegaLoader,a as VegaNotify,d as VegaSkeletonLoader,b as VegaThemeManager,w as waitForVega}from"./p-9e5f7b82.js";export{F as FeatureFlag}from"./p-f2118771.js";export{V as VegaDialog}from"./p-34964cc9.js";export{B as VegaJQueryDelegatedEventStrategy}from"./p-aae8855d.js";export{V as VegaIconManager}from"./p-9d426517.js";export{V as ValidCreditCardNumberRule}from"./p-8054bb18.js";import"./p-bb761f8f.js";import"./p-344ee7cb.js";import"./p-0c667d6a.js";import"./p-6bdc4407.js";import"./p-3a0a4d15.js";import"./p-469bc36e.js";import"./p-320642bd.js";import"./p-abf5b8f7.js";import"./p-d3f1d3dd.js";import"./p-cb13b4e6.js";import"./p-112455b1.js";import"./p-61f18887.js";import"./p-f1d8fd1c.js";const o=["ring-input-focus","dark-ring-input-focus","ring-input-danger-focus","dark-ring-input-danger-focus","ring-action-focus","dark-ring-action-focus","ring-action-danger-focus","dark-ring-action-danger-focus"];export{o as Rings}