@tylertech/forge-core 2.4.0-dev.1 → 2.4.0-dev.2

package/esm/utils/position-utils.js

@@ -1,22 +1,12 @@
-import { computePosition, flip as flipMiddleware, hide as hideMiddleware, shift as shiftMiddleware, autoPlacement as autoPlacementMiddleware } from '@floating-ui/dom';
+import { computePosition, flip as flipMiddleware, hide as hideMiddleware, shift as shiftMiddleware, offset as offsetMiddleware, autoPlacement as autoPlacementMiddleware } from '@floating-ui/dom';
 import { getContainingBlock } from '@floating-ui/utils/dom';
 import { topLayer as topLayerMiddleware } from './top-layer-middleware';
-/** Adjusts the x and y axes by a specified offset amount. */
-export const positionOffsetMiddleware = ({ x: offsetX, y: offsetY }) => ({
-    name: 'positionOffset',
-    fn({ x, y }) {
-        return {
-            x: x + offsetX,
-            y: y + offsetY
-        };
-    }
-});
 /**
  * Calculates an elements position relative to another element.
  * @param {IPositionElementConfig} config Configuration to provide when positioning the element.
  * @returns {IElementPositionResult} The result of the positioning logic.
  */
-export async function positionElementAsync({ element, targetElement, placement = 'bottom-start', offset, strategy = 'absolute', apply = true, flip = true, flipOptions = {
+export async function positionElementAsync({ element, targetElement, placement = 'bottom-start', offset = false, offsetOptions, strategy = 'absolute', apply = true, flip = true, flipOptions = {
     fallbackPlacements: ['top-start', 'top', 'top-end', 'left-start', 'left', 'left-end', 'right-start', 'right', 'right-end'],
     fallbackStrategy: 'initialPlacement'
 }, auto = false, autoOptions, shift = true, shiftOptions, hide = false, hideOptions, topLayer = false, transform = true, translateFunction = 'translate3d' }) {
@@ -24,7 +14,7 @@ export async function positionElementAsync({ element, targetElement, placement =
     const middleware = [];
     // Order of the following middleware is **important**
     if (offset) {
-        middleware.push(positionOffsetMiddleware(offset));
+        middleware.push(offsetMiddleware(offsetOptions));
     }
     if (shift) {
         middleware.push(shiftMiddleware(shiftOptions));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tylertech/forge-core",
-  "version": "2.4.0-dev.1",
+  "version": "2.4.0-dev.2",
   "description": "A library of core web utilities that support Forge Web Component libraries.",
   "author": "Tyler Technologies, Inc.",
   "license": "Apache-2.0",

package/typings/utils/position-utils.d.ts

@@ -1,13 +1,11 @@
-import { FlipOptions, ShiftOptions, AutoPlacementOptions, HideOptions, Middleware, Placement, Strategy } from '@floating-ui/dom';
+import { FlipOptions, ShiftOptions, AutoPlacementOptions, HideOptions, Placement, Strategy, OffsetOptions } from '@floating-ui/dom';
 export declare type PositionPlacement = Placement;
 export declare type PositionStrategy = Strategy;
-export interface IElementPosition {
+export interface IElementPositionResult {
+    visibility: 'visible' | 'hidden';
     x: number;
     y: number;
 }
-export interface IElementPositionResult extends IElementPosition {
-    visibility: 'visible' | 'hidden';
-}
 export interface IPositionElementConfig {
     /** The element to apply position to. */
     element: HTMLElement;
@@ -33,8 +31,10 @@ export interface IPositionElementConfig {
     auto?: boolean;
     /** Options to provide to the autoPlacement middleware. */
     autoOptions?: Partial<AutoPlacementOptions>;
-    /** Offset positioning to apply to the placement. */
-    offset?: IElementPosition;
+    /** Should any offset values be applied to the element. */
+    offset?: boolean;
+    /**  */
+    offsetOptions?: Partial<OffsetOptions>;
     /** Should the top-layer middleware be applied or not. */
     topLayer?: boolean;
     /** The positioning strategy. */
@@ -44,14 +44,12 @@ export interface IPositionElementConfig {
     /** The CSS `translate` function to apply to the `transform`. Only applied when `transform` is `true`. */
     translateFunction?: 'translate3d' | 'translate';
 }
-/** Adjusts the x and y axes by a specified offset amount. */
-export declare const positionOffsetMiddleware: ({ x: offsetX, y: offsetY }: IElementPosition) => Middleware;
 /**
  * Calculates an elements position relative to another element.
  * @param {IPositionElementConfig} config Configuration to provide when positioning the element.
  * @returns {IElementPositionResult} The result of the positioning logic.
  */
-export declare function positionElementAsync({ element, targetElement, placement, offset, strategy, apply, flip, flipOptions, auto, autoOptions, shift, shiftOptions, hide, hideOptions, topLayer, transform, translateFunction }: IPositionElementConfig): Promise<IElementPositionResult>;
+export declare function positionElementAsync({ element, targetElement, placement, offset, offsetOptions, strategy, apply, flip, flipOptions, auto, autoOptions, shift, shiftOptions, hide, hideOptions, topLayer, transform, translateFunction }: IPositionElementConfig): Promise<IElementPositionResult>;
 /**
  * Determines if the provided element is a child of a containment block.
  * @param element The element to check.