@globalpayments/vega 2.29.0 → 2.31.0

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

@@ -10,7 +10,7 @@ import { VegaSidenavOpenStatusController } from './slimmers/controllers/vega-sid
 import { EventEmitSlimmerBase } from '../../helpers/event-manager/slimmers/event-emit-slimmer';
 /**
  * @deprecated This component will be removed soon, please consider using `vega-left-nav` component instead.
- * @vegaVersion 2.29.0
+ * @vegaVersion 1, v2.29.0
  */
 export declare class VegaSidenav {
   protected readonly globalSlimmers: GlobalSlimmers;
@@ -31,7 +31,7 @@ export declare class VegaSidenav {
    * Defines the data that is used to generate the items
    *    in the side nav list.
    *
-   * @vegaVersion 2.29.0
+   * @vegaVersion 1, v2.29.0
    */
   source: SidebarTopLevelItem[];
   /**
@@ -45,14 +45,14 @@ export declare class VegaSidenav {
    * Provides additional information or context in the form of
    *    a footnote in the side nav footer.
    *
-   * @vegaVersion 2.29.0
+   * @vegaVersion 1, v2.29.0
    */
   footnote: string;
   /**
    * Specifies the configuration for the header of the side nav,
    *    allowing customization of the logo and headline.
    *
-   * @vegaVersion 2.29.0
+   * @vegaVersion 1, v2.29.0
    */
   headerConfig: SidebarHeaderConfig;
   /**
@@ -60,21 +60,21 @@ export declare class VegaSidenav {
    *    different screen sizes and disables collapse for
    *    large screens.
    *
-   * @vegaVersion 2.29.0
+   * @vegaVersion 1, v2.29.0
    */
   openByDefault: ResponsiveType<OpenByDefaultType>;
   watchOpenByDefaultChange(): void;
   /**
    * An event emitter notifying the completion of a navigation menu state change (open or close).
    *
-   * @vegaVersion 2.29.0
+   * @vegaVersion 1, v2.29.0
    */
   vegaStateUpdate: EventEmitter<string>;
   /**
    * An event emitter notifying the completion of a navigation menu state change (open or close).
    *
    * @eventSemantics namespace:native
-   * @vegaVersion 2.29.0
+   * @vegaVersion 1, v2.29.0
    */
   stateUpdate: EventEmitter<string>;
   /**
@@ -97,7 +97,7 @@ export declare class VegaSidenav {
   /**
    * Invoke this method to toggle the side navigation menu.
    *
-   * @vegaVersion 2.29.0
+   * @vegaVersion 1, v2.29.0
    */
   toggle(): Promise<void>;
   /**

package/dist/types/components.d.ts

@@ -16,7 +16,7 @@ import { VegaBreadcrumbCollapsedThresholdType, VegaBreadcrumbItemType } from "./
 import { VegaButtonIconAlign, VegaButtonSize, VegaButtonType, VegaButtonVariant } from "./components/vega-button/types";
 import { VegaButtonCircleSize, VegaButtonCircleTooltip, VegaButtonCircleVariant } from "./components/vega-button-circle/types";
 import { DropdownPropsForButtonGroup, VegaButtonGroupIconAlign, VegaButtonGroupSize, VegaButtonGroupVariant } from "./components/vega-button-group/types";
-import { DropdownSourceGroup, DropdownSourceItem, VegaDropdownSearchTriggerByType, VegaDropdownSourceItem } from "./components/vega-dropdown/types";
+import { DropdownSourceGroup, DropdownSourceItem, VegaDropdownSearchTriggerByType, VegaDropdownSearchTriggerEventDetail, VegaDropdownSourceItem } from "./components/vega-dropdown/types";
 import { DropdownPropsForCalendar, VegaCalendarChangeEventType, VegaCalendarDateClickInfo, VegaCalendarEventClickInfo, VegaCalendarRawEvent, VegaCalendarViewModeType } from "./components/vega-calendar/types";
 import { Nullable, TimeFormat } from "./types/general";
 import { CalendarEvent } from "./helpers/calendar/calendar-event";
@@ -879,6 +879,11 @@ export namespace Components {
           * @vegaVersion 1.13.0
          */
         "hint": string;
+        /**
+          * Specifies whether the color picker is inline with container styles, including a border, background color, and padding.
+          * @vegaVersion 2.30.0
+         */
+        "isInline": boolean;
         /**
           * Specifies the validation status of the color picker component.
           * @vegaVersion 1.13.0
@@ -2935,61 +2940,61 @@ export namespace Components {
     interface VegaSidenav {
         /**
           * Provides additional information or context in the form of    a footnote in the side nav footer.
-          * @vegaVersion 2.29.0
+          * @vegaVersion 1, v2.29.0
          */
         "footnote": string;
         /**
           * Specifies the configuration for the header of the side nav,    allowing customization of the logo and headline.
-          * @vegaVersion 2.29.0
+          * @vegaVersion 1, v2.29.0
          */
         "headerConfig": SidebarHeaderConfig;
         /**
           * Specifies the default open behavior for the side nav across    different screen sizes and disables collapse for    large screens.
-          * @vegaVersion 2.29.0
+          * @vegaVersion 1, v2.29.0
          */
         "openByDefault": ResponsiveType<OpenByDefaultType>;
         /**
           * Defines the data that is used to generate the items    in the side nav list.
-          * @vegaVersion 2.29.0
+          * @vegaVersion 1, v2.29.0
          */
         "source": SidebarTopLevelItem[];
         /**
           * Invoke this method to toggle the side navigation menu.
-          * @vegaVersion 2.29.0
+          * @vegaVersion 1, v2.29.0
          */
         "toggle": () => Promise<void>;
     }
     interface VegaSidenavGroup {
         /**
           * Represents the icon attached to the side navigation    group header link.
-          * @vegaVersion 2.29.0
+          * @vegaVersion 1, v2.29.0
          */
         "icon": string;
         /**
           * Specifies the text that serves as the label or title    for the side navigation group in the sidebar.
-          * @vegaVersion 2.29.0
+          * @vegaVersion 1, v2.29.0
          */
         "label": string;
     }
     interface VegaSidenavLink {
         /**
           * Specifies the icon displayed for the side navigation link.    Icons are only displayed for top-level links.
-          * @vegaVersion 2.29.0
+          * @vegaVersion 1, v2.29.0
          */
         "icon": string;
         /**
           * Indicates whether the link item is selected.
-          * @vegaVersion 2.29.0
+          * @vegaVersion 1, v2.29.0
          */
         "selected": boolean;
         /**
           * Determines if the side nav should stay open when the    sidenav-link element is clicked.
-          * @vegaVersion 2.29.0
+          * @vegaVersion 1, v2.29.0
          */
         "showSideBarOnClickLink": boolean;
         /**
           * Specifies the destination URL to which the side navigation link    navigates when clicked.
-          * @vegaVersion 2.29.0
+          * @vegaVersion 1, v2.29.0
          */
         "url": string;
     }
@@ -5668,6 +5673,11 @@ declare namespace LocalJSX {
           * @vegaVersion 1.13.0
          */
         "hint"?: string;
+        /**
+          * Specifies whether the color picker is inline with container styles, including a border, background color, and padding.
+          * @vegaVersion 2.30.0
+         */
+        "isInline"?: boolean;
         /**
           * Specifies the validation status of the color picker component.
           * @vegaVersion 1.13.0
@@ -6077,6 +6087,12 @@ declare namespace LocalJSX {
           * @vegaVersion 2.0.0
          */
         "onDropdownShow"?: (event: VegaDropdownCustomEvent<string>) => void;
+        /**
+          * An event emitter notifying the search event triggered within the dropdown,    but only if `useDefaultFilter` is set to `false`. Unlike the Vegasearch event, this event includes the details of the user who triggered it. It can be triggered in two ways: by pressing "Enter" or through user input.
+          * @eventSemantics namespace:native
+          * @vegaVersion 2.30.0
+         */
+        "onSearchTrigger"?: (event: VegaDropdownCustomEvent<VegaDropdownSearchTriggerEventDetail>) => void;
         /**
           * An event emitter notifying the addition of a new value    to the dropdown source list.  The event's `detail` property contains the new value.  The dropdown _does not_ automatically add the new value to the source list.
           * @vegaVersion 1.14.0
@@ -6097,6 +6113,11 @@ declare namespace LocalJSX {
           * @vegaVersion 1.24.0
          */
         "onVegaSearch"?: (event: VegaDropdownCustomEvent<string>) => void;
+        /**
+          * An event emitter notifying the search event triggered within the dropdown,    but only if `useDefaultFilter` is set to `false`. Unlike the Vegasearch event, this event includes the details of the user who triggered it. It can be triggered in two ways: by pressing "Enter" or through user input.
+          * @vegaVersion 2.30.0
+         */
+        "onVegaSearchTrigger"?: (event: VegaDropdownCustomEvent<VegaDropdownSearchTriggerEventDetail>) => void;
         /**
           * An event emitter notifying that the dropdown has been displayed,    either programmatically or via user interaction.
           * @vegaVersion 1.3.0
@@ -7236,6 +7257,12 @@ declare namespace LocalJSX {
           * @vegaVersion 2.0.0
          */
         "onSearch"?: (event: VegaInputSelectCustomEvent<string>) => void;
+        /**
+          * An event emitter notifying the search event triggered within the dropdown, Unlike the Vegasearch event, this event includes the details of the user who triggered it. It can be triggered in two ways: by pressing "Enter" or through user input.
+          * @eventSemantics namespace:native
+          * @vegaVersion 2.30.0
+         */
+        "onSearchTrigger"?: (event: VegaInputSelectCustomEvent<VegaDropdownSearchTriggerEventDetail>) => void;
         /**
           * An event emitter notifying the change of the select value.
           * @vegaVersion 1.0.11
@@ -7246,6 +7273,11 @@ declare namespace LocalJSX {
           * @vegaVersion 1.50.0
          */
         "onVegaSearch"?: (event: VegaInputSelectCustomEvent<string>) => void;
+        /**
+          * An event emitter notifying the search event triggered within the dropdown,    but only if `useDefaultFilter` is set to `false`. Unlike the Vegasearch event, this event includes the details of the user who triggered it. It can be triggered in two ways: by pressing "Enter" or through user input.
+          * @vegaVersion 2.30.0
+         */
+        "onVegaSearchTrigger"?: (event: VegaInputSelectCustomEvent<VegaDropdownSearchTriggerEventDetail>) => void;
         /**
           * Specifies a placeholder string that displays as a temporary hint or    example inside the input select field.  It indicates the expected format or pattern of the input.
           * @vegaVersion 1.0.7
@@ -8190,78 +8222,78 @@ declare namespace LocalJSX {
     interface VegaSidenav {
         /**
           * Provides additional information or context in the form of    a footnote in the side nav footer.
-          * @vegaVersion 2.29.0
+          * @vegaVersion 1, v2.29.0
          */
         "footnote"?: string;
         /**
           * Specifies the configuration for the header of the side nav,    allowing customization of the logo and headline.
-          * @vegaVersion 2.29.0
+          * @vegaVersion 1, v2.29.0
          */
         "headerConfig"?: SidebarHeaderConfig;
         /**
           * An event emitter notifying the completion of a navigation menu state change (open or close).
           * @eventSemantics namespace:native
-          * @vegaVersion 2.29.0
+          * @vegaVersion 1, v2.29.0
          */
         "onStateUpdate"?: (event: VegaSidenavCustomEvent<string>) => void;
         /**
           * An event emitter notifying the completion of a navigation menu state change (open or close).
-          * @vegaVersion 2.29.0
+          * @vegaVersion 1, v2.29.0
          */
         "onVegaStateUpdate"?: (event: VegaSidenavCustomEvent<string>) => void;
         /**
           * Specifies the default open behavior for the side nav across    different screen sizes and disables collapse for    large screens.
-          * @vegaVersion 2.29.0
+          * @vegaVersion 1, v2.29.0
          */
         "openByDefault"?: ResponsiveType<OpenByDefaultType>;
         /**
           * Defines the data that is used to generate the items    in the side nav list.
-          * @vegaVersion 2.29.0
+          * @vegaVersion 1, v2.29.0
          */
         "source"?: SidebarTopLevelItem[];
     }
     interface VegaSidenavGroup {
         /**
           * Represents the icon attached to the side navigation    group header link.
-          * @vegaVersion 2.29.0
+          * @vegaVersion 1, v2.29.0
          */
         "icon"?: string;
         /**
           * Specifies the text that serves as the label or title    for the side navigation group in the sidebar.
-          * @vegaVersion 2.29.0
+          * @vegaVersion 1, v2.29.0
          */
         "label"?: string;
     }
     interface VegaSidenavLink {
         /**
           * Specifies the icon displayed for the side navigation link.    Icons are only displayed for top-level links.
-          * @vegaVersion 2.29.0
+          * @vegaVersion 1, v2.29.0
          */
         "icon"?: string;
         /**
           * An event emitter notifying about the occurrence of a click event.
           * @eventSemantics namespace:native
-          * @vegaVersion 2.29.0
+          * @vegaVersion 1, v2.29.0
          */
         "onClick"?: (event: VegaSidenavLinkCustomEvent<any>) => void;
         /**
           * An event emitter notifying about the occurrence of a click event.
-          * @vegaVersion 2.29.0
+          * @vegaVersion 1, v2.29.0
          */
         "onVegaClick"?: (event: VegaSidenavLinkCustomEvent<any>) => void;
         /**
           * Indicates whether the link item is selected.
-          * @vegaVersion 2.29.0
+          * @vegaVersion 1, v2.29.0
          */
         "selected"?: boolean;
         /**
           * Determines if the side nav should stay open when the    sidenav-link element is clicked.
-          * @vegaVersion 2.29.0
+          * @vegaVersion 1, v2.29.0
          */
         "showSideBarOnClickLink"?: boolean;
         /**
           * Specifies the destination URL to which the side navigation link    navigates when clicked.
-          * @vegaVersion 2.29.0
+          * @vegaVersion 1, v2.29.0
          */
         "url"?: string;
     }

package/dist/types/constants/ui.d.ts

@@ -12,5 +12,5 @@ export declare const FlexWrap: readonly ["nowrap", "wrap", "wrap-reverse"];
 export declare const BoxDisplay: readonly ["block", "inline-block", "none"];
 export declare const BorderStyle: readonly ["solid", "dashed", "dotted", "double", "none"];
 export declare const TextAlign: readonly ["start", "end", "left", "right", "center", "justify"];
-export declare const VegaNativeEventName: readonly ["change", "click", "focus", "blur", "close", "modalOpen", "validate", "formSubmit", "formReset", "rowClick", "rowExpand", "selectChange", "selectAllChange", "pageSizeChange", "dropdownClick", "create", "search", "hide", "show", "popoverShow", "popoverHide", "cancel", "remove", "pageUpdate", "currentStepUpdate", "toggleStatus", "stateUpdate", "groupClick", "menuClick", "accordionExpand", "dropdownShow", "dropdownHide", "dropdownSearch", "actionClick", "eventClick", "dateDblClick", "countryChange", "actionButtonClick", "moreActionClick", "expand", "rowSelect", "rowSelectAll", "retry", "selectedFileChange", "preview", "labelButtonClick"];
+export declare const VegaNativeEventName: readonly ["change", "click", "focus", "blur", "close", "modalOpen", "validate", "formSubmit", "formReset", "rowClick", "rowExpand", "selectChange", "selectAllChange", "pageSizeChange", "dropdownClick", "create", "search", "searchTrigger", "hide", "show", "popoverShow", "popoverHide", "cancel", "remove", "pageUpdate", "currentStepUpdate", "toggleStatus", "stateUpdate", "groupClick", "menuClick", "accordionExpand", "dropdownShow", "dropdownHide", "dropdownSearch", "actionClick", "eventClick", "dateDblClick", "countryChange", "actionButtonClick", "moreActionClick", "expand", "rowSelect", "rowSelectAll", "retry", "selectedFileChange", "preview", "labelButtonClick"];
 export declare const CssStates: readonly ["default", "hover", "active", "focus-visible"];

package/dist/types/helpers/event-manager/event-id/vega-event-id.d.ts

@@ -63,6 +63,7 @@ export declare const VegaPageSizeChange: VegaEventID;
 export declare const VegaDropdownClick: VegaEventID;
 export declare const VegaCreate: VegaEventID;
 export declare const VegaSearch: VegaEventID;
+export declare const VegaSearchTrigger: VegaEventID;
 export declare const VegaHide: VegaEventID;
 export declare const VegaShow: VegaEventID;
 export declare const VegaPopoverShow: VegaEventID;

package/dist/types/helpers/feature-control/feature-flag.d.ts

@@ -50,4 +50,5 @@ export type FeatureFlagKey =
 	| 'VEGA_BANNER_DEPRECATED_ACTION_BUTTON_PROP_VEGA_CLICK'
 	| 'VEGA_REACT.SKIP_NATIVE_EVENT_PREVENT_BY_DEFAULT'
 	| 'VEGA_TELEMETRY.ENABLE_COLLECT_PUBLIC_API'
-	| 'VEGA_LEFT_NAV.DISABLE_ANIMATION_ON_LOAD';
+	| 'VEGA_LEFT_NAV.DISABLE_ANIMATION_ON_LOAD'
+	| 'VEGA_DATE_PICKER.ENABLE_CALCULATION_POSITION_BY_SCREEN';

package/dist/types/helpers/slimmers/element-appender-container/body-positioned-wrapper/body-positioned-wrapper.abstract.d.ts

@@ -0,0 +1,15 @@
+import { ElementAppenderShowConfig } from '../../../ui/element-appender';
+import { ElementAppenderContainerRetriever } from '../element-appender-container-controller';
+/**
+ * Body positioned wrapper.
+ */
+export declare abstract class BodyPositionedWrapper implements ElementAppenderContainerRetriever {
+  abstract showConfig: ElementAppenderShowConfig;
+  /**
+   * Valid is a body position used wrapper.
+   *
+   * @returns {boolean} can retrieve or not.
+   */
+  canRetrieve(): boolean;
+  abstract retrieve(): HTMLElement;
+}

package/dist/types/helpers/slimmers/element-appender-container/{position-relative-to-wrapper.d.ts → body-positioned-wrapper/position-relative-to-wrapper.d.ts}

@@ -1,22 +1,22 @@
-import { ElementAppenderShowConfig } from '../../ui/element-appender';
-import { ElementAppenderContainerRetriever } from './element-appender-container-controller';
+import { ElementAppenderShowConfig } from '../../../ui/element-appender';
+import { BodyPositionedWrapper } from './body-positioned-wrapper.abstract';
 /**
  * This class is is used to retrieve an HTML element based on a specified selector.
  *
  * @property {HTMLElement} showConfig the show config
  */
-export declare class PositionRelativeToWrapper implements ElementAppenderContainerRetriever {
+export declare class PositionRelativeToWrapper extends BodyPositionedWrapper {
   showConfig: ElementAppenderShowConfig;
   /**
    * The canRetrieve function just determines whether the showConfig contains the positionRelativeTo object.
    *
    * @returns {boolean} the boolean type.
    */
-  canRetrieve: () => boolean;
+  canRetrieve(): boolean;
   /**
    * The retrieve function query the element of positionRelativeTo in showConfig.
    *
    * @returns {HTMLElement} the element.
    */
-  retrieve: () => HTMLElement;
+  retrieve(): HTMLElement;
 }

package/dist/types/helpers/slimmers/element-appender-container/{vega-modal-wrapper.d.ts → body-positioned-wrapper/vega-modal-wrapper.d.ts}

@@ -1,24 +1,24 @@
-import { ElementAppenderShowConfig } from '../../ui/element-appender';
-import { ElementAppenderContainerRetriever } from './element-appender-container-controller';
+import { ElementAppenderShowConfig } from '../../../ui/element-appender';
+import { BodyPositionedWrapper } from './body-positioned-wrapper.abstract';
 /**
  * This class is is used to get vega-modal element as a container and store the element appender element to slot.
  *
  * @property {HTMLElement} showConfig the show config
  */
-export declare class VegaModalWrapper implements ElementAppenderContainerRetriever {
+export declare class VegaModalWrapper extends BodyPositionedWrapper {
   showConfig: ElementAppenderShowConfig;
   /**
    * The canRetrieve function just determines whether the target of showConfig has the `vega-modal` element. If not, search upwards layer by layer.
    *
    * @returns {boolean} the boolean type.
    */
-  canRetrieve: () => boolean;
+  canRetrieve(): boolean;
   /**
    * The retrieve function get the slot position of vega-modal element.
    *
    * @returns {HTMLElement} the element.
    */
-  retrieve: () => HTMLElement;
+  retrieve(): HTMLElement;
   /**
    * This function `getVegaModalContentWithoutScroll` determines whether vega-modal has a slot whose name is `content` or `modal-content`. If there is a component rendered in the modal, the elementAppender added to the corresponding slot attribute is added. If not, the elementAppender is not directly appended to the root directory of vega-modal.
    *

package/dist/types/helpers/slimmers/element-appender-container/{vega-popover-wrapper.d.ts → body-positioned-wrapper/vega-popover-wrapper.d.ts}

@@ -1,22 +1,22 @@
-import { ElementAppenderShowConfig } from '../../ui/element-appender';
-import { ElementAppenderContainerRetriever } from './element-appender-container-controller';
+import { ElementAppenderShowConfig } from '../../../ui/element-appender';
+import { BodyPositionedWrapper } from './body-positioned-wrapper.abstract';
 /**
  * This class is used to get the class `vega-popover` as a container and store the element appender element.
  *
  * @property {HTMLElement} showConfig the show config
  */
-export declare class VegaPopoverWrapper implements ElementAppenderContainerRetriever {
+export declare class VegaPopoverWrapper extends BodyPositionedWrapper {
   showConfig: ElementAppenderShowConfig;
   /**
    * The canRetrieve function just determine whether the target of showConfig has the class `vega-popover`. If not, search upwards layer by layer.
    *
    * @returns {boolean} the boolean type.
    */
-  canRetrieve: () => boolean;
+  canRetrieve(): boolean;
   /**
    * The retrieve function get the element that if the target of showConfig does not have the class vega-popover, search upwards layer by layer until this element is found.
    *
    * @returns {HTMLElement} the element.
    */
-  retrieve: () => HTMLElement;
+  retrieve(): HTMLElement;
 }

package/dist/types/helpers/slimmers/element-appender-container/default-wrapper.d.ts

@@ -10,11 +10,11 @@ export declare class DefaultWrapper implements ElementAppenderContainerRetriever
    *
    * @returns {boolean} the boolean type.
    */
-  canRetrieve: () => boolean;
+  canRetrieve(): boolean;
   /**
    * The retrieve function get the body element of document.
    *
    * @returns {HTMLElement} the element.
    */
-  retrieve: () => HTMLElement;
+  retrieve(): HTMLElement;
 }

package/dist/types/helpers/slimmers/element-appender-container/element-appender-container-controller.d.ts

@@ -1,9 +1,9 @@
 import { VegaSlimmer } from '../../../vega-slimmer/vega-slimmer-core';
 import { ElementAppenderShowConfig } from '../../ui/element-appender';
 import { DefaultWrapper } from './default-wrapper';
-import { PositionRelativeToWrapper } from './position-relative-to-wrapper';
-import { VegaModalWrapper } from './vega-modal-wrapper';
-import { VegaPopoverWrapper } from './vega-popover-wrapper';
+import { PositionRelativeToWrapper } from './body-positioned-wrapper/position-relative-to-wrapper';
+import { VegaModalWrapper } from './body-positioned-wrapper/vega-modal-wrapper';
+import { VegaPopoverWrapper } from './body-positioned-wrapper/vega-popover-wrapper';
 export interface ElementAppenderContainerRetriever {
   canRetrieve: () => boolean;
   retrieve: () => HTMLElement;

package/dist/types/helpers/slimmers/element-appender-slimmer.d.ts

@@ -49,6 +49,7 @@ export declare class ElementAppenderSlimmer extends VegaSlimmer {
   private elementMouseEnterHandler;
   private elementMouseLeaveHandler;
   private globalMouseDownHandler;
+  private globalScrollHandler;
   private createDelayHideTimer;
   private clearDelayHideTimer;
   private shouldListenerWork;

package/dist/types/helpers/slimmers/position-calculation/base-position-calculation-strategy.d.ts

@@ -0,0 +1,138 @@
+import { VegaSlimmer } from '../../../vega-slimmer/vega-slimmer-core';
+import { ElementBoundBox, ElementPositionBox, ElementScrollDimension, PlacementType, PositionAlignmentType } from '../../../types/ui.type';
+import { ElementAppenderShowConfig } from '../../ui/element-appender';
+/**
+ * calculate position
+ */
+export declare abstract class BasePositionCalculationStrategy extends VegaSlimmer {
+  abstract showConfig: ElementAppenderShowConfig;
+  /**
+   * Get the position box.
+   *
+   * @param {PlacementType[]} placement - previous placement.
+   * @param {PositionAlignmentType[]} alignment - previous placement.
+   * @returns {ElementPositionBox} A function that takes in a container, element, target, placement, and translocation and
+   * returns an ElementPositionBox.
+   */
+  protected getPositionBox(placement?: PlacementType[], alignment?: PositionAlignmentType[]): ElementPositionBox;
+  /**
+   * "Get the width, height, and top position of an element."
+   *
+   * The function takes an element as an argument and returns an object with three properties: width,
+   * height, and top.
+   *
+   * Note: If element is hide, we should temporary change it to `block` to get the bounding client rect of element,
+   * After do that, this element will change to origin `hide`, if not, it will be contained in the calculate of `document.documentElement.scrollHeight`
+   *
+   * @returns {ElementBoundBox} An object with the width, height, and top properties of the element.
+   */
+  private getElementBoundBox;
+  /**
+   * It takes a placement string or array of placements and returns an array of placements
+   * if given placement is single, we should completion the placements with the default {@link Placements}
+   * and make given placement as default.
+   * if given placement is array, we should use it directly, even it partial of {@link Placements}.
+   * if not placement give. we should use {@link Placements}.
+   *
+   * @returns {PlacementType[]} ordered placements.
+   */
+  private getPlacements;
+  /**
+   * It returns acceptable alignments.
+   *
+   * @returns {PositionAlignmentType[]} acceptable alignments
+   */
+  private getAlignments;
+  /**
+   * It takes a placement, a target box, and a element box, and returns an element box
+   *
+   * @param {ElementBoundBox} elementBox - The position of the element element.
+   * @param {ElementBoundBox} targetBox - The position of the target element.
+   * @param {PlacementType} placement - The placement of the element.
+   * @param {PositionAlignmentType} alignment - The alignment of the element
+   * @returns {ElementPositionBox} An object with top and left properties.
+   */
+  private calculatePosition;
+  /**
+   * It returns the translocation of the element relative to the target element
+   *
+   * @param {PlacementType} placement - The suitable placement of the element.
+   * @returns {TranslocationType} A translocation object with X and Y properties.
+   */
+  private getTranslocationBox;
+  /**
+   * Calculate the left position of the element
+   *
+   * @param {ElementBoundBox} elementBox - The position box of the element.
+   * @param {ElementBoundBox} targetBox - The position box of the target element that is attached to.
+   * @param {PlacementType} placement - The placement of the element.
+   * @param {PositionAlignmentType} alignment - The alignment of the element
+   * @returns {number} The left position of the element.
+   */
+  private calculateLeft;
+  /**
+   * Calculate the top position of the element
+   *
+   * @param {ElementBoundBox} elementBox - The position box of the element.
+   * @param {ElementBoundBox} targetBox - The position box of the target element that is attached to.
+   * @param {PlacementType} placement - The placement of the element.
+   * @param {PositionAlignmentType} alignment - The alignment of the element
+   * @returns {number} the top position of the element.
+   */
+  private calculateTop;
+  /**
+   * It takes a list of placements and returns the first placement that has enough space to place the
+   * element
+   *
+   * @param {ElementScrollDimension} containerBox - The box of the container element.
+   * @param {ElementBoundBox} elementBox - The box of the element to be placed.
+   * @param {ElementBoundBox} targetBox - The box of the target element.
+   * @param {PlacementType[]} placements - The placements that we want to try.
+   * @returns {PlacementType} A function that takes in a containerBox, elementBox, targetBox, placements, and element.
+   */
+  private getSuitablePlacement;
+  /**
+   * It takes a list of alignments and returns the suitable one that has enough space to fit the element
+   *
+   * @param {ElementScrollDimension} containerBox - The bounding box of the container element.
+   * @param {ElementBoundBox} elementBox - The box of the element that we want to position.
+   * @param {ElementBoundBox} targetBox - The box of the element that the element to be positioned is aligned to.
+   * @param {PlacementType} placement - The placement of the element relative to the target.
+   * @param {PositionAlignmentType[]} alignments - An array of alignments to try.
+   * @returns {PositionAlignmentType} the alignment that is suitable for the element.
+   */
+  private getSuitableAlignment;
+  /**
+   * Whether the alignment space is enough
+   *
+   * @param {ElementScrollDimension} containerBox - The bounding box of the container element.
+   * @param {ElementBoundBox} targetBox - The position of the target element.
+   * @param {ElementBoundBox} elementBox - The box of the element that we're trying to position.
+   * @param {PlacementType} placement - The placement of the element relative to the target.
+   * @param {PlacementType} alignment - The alignment of the element relative to the target.
+   * @returns {boolean} return true if it has enough space, otherwise false
+   */
+  private hasEnoughAlignmentSpace;
+  /**
+   * If the placement is top or left, then the target's top or left position must be greater than or
+   * equal to the element's height or width. If the placement is bottom or right, then the container's
+   * height or width minus the target's top or left position minus the target's height or width must be
+   * greater than or equal to the element's height or width.
+   *
+   * @param {ElementScrollDimension} containerBox - The bounding box of the container element.
+   * @param {PlacementType} placement - The placement of the element.
+   * @param {ElementBoundBox} targetBox - The position of the target element.
+   * @param {ElementBoundBox} elementBox - The dimensions of the element to be positioned.
+   * @returns {boolean} A boolean value.
+   */
+  private hasEnoughSpace;
+  /**
+   * Retrieves and formats the translocation.
+   *
+   * @returns {TranslocationType} current translocation.
+   */
+  private getTranslocation;
+  abstract getPosition(usePreviousPlacement?: boolean): ElementPositionBox;
+  protected abstract getTargetBoundBox(): ElementBoundBox;
+  protected abstract getElementScrollDimension(): ElementScrollDimension;
+}