@atlaskit/top-layer 0.1.5 → 0.3.0

package/dist/cjs/internal/use-anchor-positioning.js

@@ -19,8 +19,24 @@ var _rafSchd = _interopRequireDefault(require("raf-schd"));
 var _once = _interopRequireDefault(require("@atlaskit/ds-lib/once"));
 var _anchorPositioningFallback = require("./anchor-positioning-fallback");
 var _combine = require("./combine");
+var _resolveCssLengthToPixels = require("./resolve-css-length-to-pixels");
 var _resolvePlacement = require("./resolve-placement");
 var _setStyle = require("./set-style");
+/**
+ * Anchor positioning for top-layer popovers. See
+ * `notes/architecture/positioning.md` for the full model.
+ *
+ * Two runtime paths: CSS Anchor Positioning (modern browsers) and a JS
+ * fallback that measures the trigger and writes `top`/`left`.
+ *
+ * Both paths honour `offset.gap` and `offset.crossAxisShift`. The
+ * CSS path passes the values through as strings; the JS fallback resolves
+ * them to pixels via a hidden DOM probe (see `resolveCssLengthToPixels`)
+ * so tokens, `calc()`, `var()`, etc all work. The JS fallback hides the
+ * popover with `opacity: 0` until the first measurement completes, so it
+ * is never painted at the wrong location.
+ */
+
 /**
  * Resolves placement options to CSS `position-area` syntax.
  *
@@ -100,6 +116,19 @@ function placementToTryFallbacks(_ref2) {
   return ["".concat(sameEdge, " span-").concat(crossAxis, "-end"), "".concat(sameEdge, " span-").concat(crossAxis, "-start"), flipKeyword, "".concat(oppositeEdge, " span-").concat(crossAxis, "-end"), "".concat(oppositeEdge, " span-").concat(crossAxis, "-start")].join(', ');
 }
 
+/**
+ * Returns true when the popover is currently open. Wrapped because the
+ * `:popover-open` pseudo-class is not implemented in some test environments
+ * (e.g. jsdom), where `matches` throws on unknown selectors.
+ */
+function isPopoverOpen(popover) {
+  try {
+    return popover.matches(':popover-open');
+  } catch (_unused) {
+    return false;
+  }
+}
+
 /**
  * Detects whether the browser supports CSS Anchor Positioning.
  * Uses `once()` for lazy evaluation — safe for SSR and avoids hydration mismatches.
@@ -111,12 +140,6 @@ var supportsAnchorPositioning = (0, _once.default)(function () {
   return CSS.supports('anchor-name', '--a');
 });
 
-/**
- * Default gap between the popover and its trigger (in pixels).
- * Maps to `space.100` (8px) in the design token scale.
- */
-var DEFAULT_OFFSET = 8;
-
 /**
  * Returns the CSS margin declaration that creates a gap between the
  * popover and its trigger on the side facing the anchor.
@@ -129,7 +152,7 @@ function edgeMargin(_ref3) {
     offset = _ref3.offset;
   var axis = placement.axis,
     edge = placement.edge;
-  var value = "".concat(offset, "px");
+  var value = offset;
   if (axis === 'block' && edge === 'end') {
     return {
       property: 'margin-block-start',
@@ -160,6 +183,33 @@ function edgeMargin(_ref3) {
   };
 }
 
+/**
+ * Cross-axis shift margin. Margin side matches the popover's anchored
+ * cross-axis edge: `align: 'start'` uses the START margin, `align: 'end'`
+ * uses the END margin with the sign inverted (so `forwards` is always
+ * positive), `align: 'center'` uses START. Margin on the un-anchored side
+ * has no effect under CSS Anchor Positioning.
+ */
+function crossAxisShiftMargin(_ref4) {
+  var placement = _ref4.placement,
+    crossAxisShiftCssValue = _ref4.crossAxisShiftCssValue,
+    direction = _ref4.direction;
+  var axis = placement.axis,
+    align = placement.align;
+  var directionSign = direction === 'forwards' ? 1 : -1;
+  var crossAxis = axis === 'block' ? 'inline' : 'block';
+  var useEndSide = align === 'end';
+  var side = useEndSide ? 'end' : 'start';
+  var sideSign = useEndSide ? -1 : 1;
+  var finalSign = directionSign * sideSign;
+  // Wrap any string in calc() with the sign factor. CSS handles the math.
+  var value = finalSign === 1 ? crossAxisShiftCssValue : "calc(-1 * ".concat(crossAxisShiftCssValue, ")");
+  return {
+    property: "margin-".concat(crossAxis, "-").concat(side),
+    value: value
+  };
+}
+
 /**
  * Hook that positions an element relative to an anchor element using
  * CSS Anchor Positioning (with a JS fallback for older browsers).
@@ -176,15 +226,13 @@ function edgeMargin(_ref3) {
  * `position: fixed` with measured coordinates, re-running on scroll (capture)
  * and resize events.
  */
-function useAnchorPosition(_ref4) {
-  var anchorRef = _ref4.anchorRef,
-    popoverRef = _ref4.popoverRef,
-    placement = _ref4.placement,
-    _ref4$offset = _ref4.offset,
-    offset = _ref4$offset === void 0 ? DEFAULT_OFFSET : _ref4$offset,
-    _ref4$forceFallbackPo = _ref4.forceFallbackPositioning,
-    forceFallbackPositioning = _ref4$forceFallbackPo === void 0 ? false : _ref4$forceFallbackPo,
-    arrow = _ref4.arrow;
+function useAnchorPosition(_ref5) {
+  var anchorRef = _ref5.anchorRef,
+    popoverRef = _ref5.popoverRef,
+    placement = _ref5.placement,
+    _ref5$forceFallbackPo = _ref5.forceFallbackPositioning,
+    forceFallbackPositioning = _ref5$forceFallbackPo === void 0 ? false : _ref5$forceFallbackPo,
+    arrow = _ref5.arrow;
   var id = (0, _react.useId)();
   var anchorName = "--anchor-".concat(id.replace(/:/g, ''));
   (0, _react.useLayoutEffect)(function () {
@@ -196,11 +244,18 @@ function useAnchorPosition(_ref4) {
     var resolvedPlacement = (0, _resolvePlacement.getPlacement)({
       placement: placement
     });
+    var gapCssValue = resolvedPlacement.offset.gap;
+    var crossAxisShiftCssValue = resolvedPlacement.offset.crossAxisShift.value;
     var shouldForceFallback = Boolean(forceFallbackPositioning);
     if (supportsAnchorPositioning() && !shouldForceFallback) {
       var gap = edgeMargin({
         placement: resolvedPlacement,
-        offset: offset
+        offset: gapCssValue
+      });
+      var crossAxisShift = crossAxisShiftMargin({
+        placement: resolvedPlacement,
+        crossAxisShiftCssValue: crossAxisShiftCssValue,
+        direction: resolvedPlacement.offset.crossAxisShift.direction
       });
       var popoverStyles = [{
         property: 'position-anchor',
@@ -227,17 +282,62 @@ function useAnchorPosition(_ref4) {
         property: 'inset',
         value: 'auto'
       },
-      // Gap between the popover and its trigger
+      // Main-axis gap between the popover and its trigger
       {
         property: gap.property,
         value: gap.value
+      },
+      // Cross-axis shift
+      {
+        property: crossAxisShift.property,
+        value: crossAxisShift.value
       }];
+
+      // Surface the active cross-axis shift value as a custom property so
+      // each named arrow @position-try rule can re-apply it after a flip.
+      // The four properties cover (cross-axis, side); only one is non-zero
+      // at a time.
+      popoverStyles.push({
+        property: '--ds-cross-axis-shift-margin-start',
+        value: '0px'
+      });
+      popoverStyles.push({
+        property: '--ds-cross-axis-shift-margin-end',
+        value: '0px'
+      });
+      popoverStyles.push({
+        property: '--ds-cross-axis-shift-margin-block-start',
+        value: '0px'
+      });
+      popoverStyles.push({
+        property: '--ds-cross-axis-shift-margin-block-end',
+        value: '0px'
+      });
+      var crossAxisShiftActive = crossAxisShiftMargin({
+        placement: resolvedPlacement,
+        crossAxisShiftCssValue: crossAxisShiftCssValue,
+        direction: resolvedPlacement.offset.crossAxisShift.direction
+      });
+      // Map margin property to its corresponding custom property name.
+      var customPropertyByMarginProperty = {
+        'margin-inline-start': '--ds-cross-axis-shift-margin-start',
+        'margin-inline-end': '--ds-cross-axis-shift-margin-end',
+        'margin-block-start': '--ds-cross-axis-shift-margin-block-start',
+        'margin-block-end': '--ds-cross-axis-shift-margin-block-end'
+      };
+      var crossAxisShiftCustomProperty = customPropertyByMarginProperty[crossAxisShiftActive.property];
+      if (crossAxisShiftCustomProperty) {
+        popoverStyles.push({
+          property: crossAxisShiftCustomProperty,
+          value: crossAxisShiftActive.value
+        });
+      }
       if (arrow) {
         // Set the arrow size variable used by the injected arrow CSS
         // and the @position-try rules for margin values.
         popoverStyles.push({
           property: '--ds-arrow-size',
-          value: "".concat(offset, "px")
+          value: gapCssValue
         });
         // Mark the popover root as the arrow host. The ARROW_CSS targets
         // [data-ds-popover-arrow] to apply clip-path: inset(0) margin-box
@@ -275,6 +375,7 @@ function useAnchorPosition(_ref4) {
       }]
     });
     function update() {
+      var _popover$parentElemen;
       if (!trigger || !popover) {
         return;
       }
@@ -283,41 +384,86 @@ function useAnchorPosition(_ref4) {
         width: window.innerWidth,
         height: window.innerHeight
       };
+
+      // Resolve consumer-supplied CSS length strings (tokens, calc, var,
+      // px, rem, etc) to pixels. The probe is mounted next to the popover
+      // so it inherits the same custom-property scope and font size.
+      // `popover.parentElement` is guaranteed to exist for any rendered
+      // popover (the popover itself is appended somewhere in the tree),
+      // but fall back to the popover element if not for safety.
+      var probeContainer = (_popover$parentElemen = popover.parentElement) !== null && _popover$parentElemen !== void 0 ? _popover$parentElemen : popover;
+      var gapPx = (0, _resolveCssLengthToPixels.resolveCssLengthToPixels)({
+        value: gapCssValue,
+        container: probeContainer
+      });
+      var crossAxisShiftPx = (0, _resolveCssLengthToPixels.resolveCssLengthToPixels)({
+        value: crossAxisShiftCssValue,
+        container: probeContainer
+      });
       var _computeFallbackPosit = (0, _anchorPositioningFallback.computeFallbackPosition)({
           triggerRect: triggerRect,
           popoverEl: popover,
           placement: resolvedPlacement,
           viewport: viewport,
-          offset: offset
+          gap: gapPx,
+          crossAxisShift: {
+            value: crossAxisShiftPx,
+            direction: resolvedPlacement.offset.crossAxisShift.direction
+          }
         }),
         top = _computeFallbackPosit.top,
         left = _computeFallbackPosit.left;
       popover.style.setProperty('top', "".concat(top, "px"));
       popover.style.setProperty('left', "".concat(left, "px"));
+      // Reveal the popover only after it has been positioned.
+      // See the toggle listener below for why we hide on open.
+      popover.style.removeProperty('opacity');
     }
 
     // Throttle scroll/resize updates to one per animation frame
     var scheduledUpdate = (0, _rafSchd.default)(update);
-    var pendingFrame = null;
+
+    // Wait for the FIRST valid layout before measuring: the popover
+    // is `display: none` until `showPopover()`, and some browsers
+    // fire `toggle` before layout, so RAF-after-toggle is unreliable.
+    // ResizeObserver fires once the browser has real dimensions.
+    // Self-disconnects after one valid measurement; ongoing
+    // scroll/resize is handled by the window listeners below.
+    var resizeObserver = new ResizeObserver(function () {
+      if (popover.offsetWidth > 0 && popover.offsetHeight > 0) {
+        update();
+        resizeObserver.disconnect();
+      }
+    });
+
+    // If the popover is already open by the time this effect runs (for
+    // example, the parent `useAnchorPosition` effect runs after the child
+    // `Popover` effect that called `showPopover()`), the initial `toggle`
+    // event has already fired and our listener below would miss it. Start
+    // observing immediately so the first measurement still happens.
+    if (isPopoverOpen(popover)) {
+      popover.style.setProperty('opacity', '0');
+      resizeObserver.observe(popover);
+    }
     var undoPositioning = (0, _combine.combine)(cleanupBaseStyles,
-    // Position when the popover transitions to visible.
-    // The popover starts hidden (`display: none` per the popover
-    // UA stylesheet), so `offsetWidth`/`offsetHeight` are 0 until
-    // `showPopover()` is called. We defer positioning to the next
-    // animation frame because some browsers (Firefox) fire the
-    // `toggle` event synchronously during `showPopover()`, before
-    // the element has been laid out — so dimensions are still 0.
-    // Waiting one frame guarantees layout has run and measurements
-    // are accurate.
+    // On every open: hide synchronously so the user never sees
+    // the UA-default position, then re-observe for a fresh
+    // measurement. We use `opacity: 0` rather than
+    // `visibility: hidden` because Firefox skips visibility-hidden
+    // elements during `<dialog>` initial-focus traversal — see
+    // `form-in-popup.spec.tsx` on `desktop-firefox`.
     (0, _bindEventListener.bind)(popover, {
       type: 'toggle',
       listener: function listener(event) {
         var toggleEvent = event;
         if (toggleEvent.newState === 'open') {
-          pendingFrame = requestAnimationFrame(update);
+          popover.style.setProperty('opacity', '0');
+          resizeObserver.observe(popover);
         }
       }
-    }), (0, _bindEventListener.bind)(window, {
+    }), function () {
+      return resizeObserver.disconnect();
+    }, (0, _bindEventListener.bind)(window, {
       type: 'scroll',
       listener: scheduledUpdate,
       options: {
@@ -332,12 +478,10 @@ function useAnchorPosition(_ref4) {
       }
     }), function () {
       scheduledUpdate.cancel();
-      if (pendingFrame !== null) {
-        cancelAnimationFrame(pendingFrame);
-      }
       popover.style.removeProperty('top');
       popover.style.removeProperty('left');
+      popover.style.removeProperty('opacity');
     });
     return undoPositioning;
-  }, [anchorRef, popoverRef, placement, anchorName, offset, forceFallbackPositioning, arrow]);
+  }, [anchorRef, popoverRef, placement, anchorName, forceFallbackPositioning, arrow]);
 }

package/dist/cjs/placement-map/index.js

@@ -1,10 +1,15 @@
 "use strict";
 
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.fromLegacyPlacement = fromLegacyPlacement;
 exports.placementMapping = void 0;
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
+function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
+function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { (0, _defineProperty2.default)(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
 /**
  * Legacy Popper.js placement values (used by `@atlaskit/popper`, `@atlaskit/popup`,
  * `@atlaskit/tooltip`, etc.).
@@ -135,11 +140,34 @@ var placementMapping = exports.placementMapping = {
 };
 
 /**
- * Convert a legacy Popper.js placement to the new CSS `position-area`-based Placement.
+ * Convert a legacy Popper.js placement to the new `position-area`-based Placement.
+ * Optional `offset` is the legacy Popper `[along, away]` tuple (also known as
+ * `[skidding, distance]`); negative `along` becomes `direction: 'backwards'`.
+ *
+ * The tuple keeps the historical popper names so call sites that already pass
+ * `[along, away]` migrate without thinking; the new internal field names
+ * (`gap` / `crossAxisShift`) are produced inside this adapter.
  */
 function fromLegacyPlacement(_ref) {
-  var legacy = _ref.legacy;
-  return placementMapping[legacy];
+  var legacy = _ref.legacy,
+    offset = _ref.offset;
+  var basePlacement = placementMapping[legacy];
+  if (!offset) {
+    return basePlacement;
+  }
+  var _offset = (0, _slicedToArray2.default)(offset, 2),
+    along = _offset[0],
+    away = _offset[1];
+  return _objectSpread(_objectSpread({}, basePlacement), {}, {
+    offset: {
+      gap: away,
+      crossAxisShift: {
+        // Sign is captured in `direction`; `value` is the magnitude.
+        value: Math.abs(along),
+        direction: along >= 0 ? 'forwards' : 'backwards'
+      }
+    }
+  });
 }
 
 /**

package/dist/cjs/popup/popup-content.js

@@ -41,7 +41,6 @@ var PopupContent = exports.PopupContent = /*#__PURE__*/(0, _react.forwardRef)(fu
     placementProp = _ref.placement,
     onCloseProp = _ref.onClose,
     testIdProp = _ref.testId,
-    offsetProp = _ref.offset,
     forceFallbackPositioningProp = _ref.forceFallbackPositioning;
   // When inside <Popup>, context provides defaults. Props always win.
   var ctx = (0, _popupContext.useMaybePopupContext)();
@@ -138,7 +137,6 @@ var PopupContent = exports.PopupContent = /*#__PURE__*/(0, _react.forwardRef)(fu
     },
     popoverRef: popoverRef,
     placement: placement,
-    offset: offsetProp,
     forceFallbackPositioning: forceFallbackPositioning,
     arrow: arrowPreset !== null && arrowPreset !== void 0 ? arrowPreset : undefined
   });