@muraldevkit/ui-toolkit 4.35.1 → 4.35.2-dev-6GR3.1

package/dist/hooks/useTriggerPosition/constants.d.ts

@@ -7,4 +7,5 @@ export interface Alignment {
 export interface Position {
     top: number;
     left: number;
+    flipped: boolean;
 }

package/dist/hooks/useTriggerPosition/flip-position.d.ts

@@ -0,0 +1,8 @@
+import { MenuPosition } from '../../components/menu/constants';
+/**
+ * Flips the given position to its opposite.
+ *
+ * @param pos - The position to flip. Can be 'left', 'right', 'top', or 'bottom'.
+ * @returns The flipped position. Will be 'right' for 'left', 'left' for 'right', 'bottom' for 'top', and 'top' for 'bottom'.
+ */
+export declare const flipPosition: (pos: MenuPosition) => MenuPosition;

package/dist/hooks/useTriggerPosition/utilities.d.ts

@@ -1,11 +1,11 @@
 import { Alignment, Position } from './constants';
 /**
- *  Calculates the position of the menu based on the alignment and offset
+ * Calculates the position of the menu based on alignment and viewport constraints.
  *
- * @param menuAlign - the alignment of the menu
- * @param offset - the offset from the trigger
- * @param elementRect - the bounding client rect of the menu
- * @param triggerRect - the bounding client rect of the trigger
- * @returns - the position of the menu
+ * @param {Alignment} menuAlign - The alignment configuration for the menu.
+ * @param {number} offset - The offset distance between the menu and the trigger.
+ * @param {DOMRect} elementRect - The bounding rectangle of the menu element.
+ * @param {DOMRect} [triggerRect] - The bounding rectangle of the trigger element.
+ * @returns {Position} The calculated position of the menu.
  */
 export declare const calculatePosition: (menuAlign: Alignment, offset: number, elementRect: DOMRect, triggerRect?: DOMRect) => Position;