@aurora-ds/components 1.7.18 → 1.7.20

package/dist/index.d.ts

@@ -2818,8 +2818,14 @@ type DialogComponent = FC<DialogProps> & {
 
 declare const Dialog: DialogComponent;
 
-/** Where the menu opens relative to its anchor. */
-type MenuPlacement = 'bottom' | 'right';
+/**
+ * Where the menu opens relative to its anchor.
+ * - `'bottom'` — opens below the anchor (default dropdown).
+ * - `'right'` — opens to the right of the anchor, flips left when no room.
+ * - `'left'` — opens to the left of the anchor, flips right when no room.
+ * - `'top'` — opens above the anchor, flips below when no room.
+ */
+type MenuPlacement = 'bottom' | 'right' | 'left' | 'top';
 type UseMenuPositionOptions = {
     /** Anchor element the menu is positioned relative to. */
     anchorEl?: HTMLElement | null;
@@ -2834,7 +2840,9 @@ type UseMenuPositionOptions = {
     /**
      * Where the menu opens relative to the anchor.
      * - `'bottom'` — opens below the anchor (default dropdown).
-     * - `'right'` — opens beside the anchor (submenu), flipping to the left when there is no room.
+     * - `'right'` — opens to the right of the anchor, flips left when no room.
+     * - `'left'` — opens to the left of the anchor, flips right when no room.
+     * - `'top'` — opens above the anchor, flips below when no room.
      * @default 'bottom'
      */
     placement?: MenuPlacement;
@@ -2948,7 +2956,14 @@ type MenuItemProps = HTMLAttributes<HTMLLIElement> & {
      * @a11y Recommended — exposes `aria-haspopup="menu"` and `aria-expanded`.
      */
     submenu?: ReactNode;
-    /** Where the submenu opens relative to the item. @default 'right' */
+    /**
+     * Direction in which the submenu opens relative to the item.
+     * - `'right'` — opens to the right, flips left when no room (default).
+     * - `'left'` — opens to the left, flips right when no room.
+     * - `'bottom'` — opens below the item.
+     * - `'top'` — opens above the item, flips below when no room.
+     * @default 'right'
+     */
     submenuPlacement?: MenuPlacement;
 };
 
@@ -3175,12 +3190,12 @@ declare const useListKeyNav: ({ itemCount, enabled, onSelect, isDisabled, loop,
  * Computes and continuously updates the `position: fixed` style for a menu panel.
  *
  * Positioning strategy:
- * - `placement="bottom"` (default): the menu opens below the anchor. If it would
- *   overflow the bottom of the viewport, `top` is shifted up so the menu bottom
- *   lands at `viewportHeight - margin` (never going off the top of the screen).
- * - `placement="right"` (submenu): the menu opens to the right of the anchor and
- *   flips to the left when there is no horizontal room. Its `top` aligns with the
- *   anchor top and is clamped to the viewport.
+ * - `placement="bottom"` (default): opens below the anchor; overflows are shifted up.
+ * - `placement="top"`: opens above the anchor; flips to bottom when no room.
+ * - `placement="right"`: opens to the right of the anchor; flips to the left when no room.
+ * - `placement="left"`: opens to the left of the anchor; flips to the right when no room.
+ *
+ * In all cases the vertical position is clamped inside the viewport.
  *
  * Scroll handling: the page scroll is locked while the menu is open (see
  * `MenuPanel`), so the anchor cannot move out from under the menu. As a safety

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aurora-ds/components",
-  "version": "1.7.18",
+  "version": "1.7.20",
   "type": "module",
   "description": "Aurora DS - React Components Library",
   "main": "dist/cjs/index.js",