@wordpress/components 19.15.0 → 20.0.0

package/build/popover/index.js

@@ -15,25 +15,30 @@ var _classnames = _interopRequireDefault(require("classnames"));
 
 var _reactDom = require("@floating-ui/react-dom");
 
+var _framerMotion = require("framer-motion");
+
 var _compose = require("@wordpress/compose");
 
 var _icons = require("@wordpress/icons");
 
 var _deprecated = _interopRequireDefault(require("@wordpress/deprecated"));
 
+var _primitives = require("@wordpress/primitives");
+
 var _button = _interopRequireDefault(require("../button"));
 
 var _scrollLock = _interopRequireDefault(require("../scroll-lock"));
 
 var _slotFill = require("../slot-fill");
 
-var _animate = require("../animate");
+var _utils = require("./utils");
 
 // @ts-nocheck
 
 /**
  * External dependencies
  */
+// eslint-disable-next-line no-restricted-imports
 
 /**
  * WordPress dependencies
@@ -48,57 +53,57 @@ var _animate = require("../animate");
  *
  * @type {string}
  */
-const SLOT_NAME = 'Popover';
-const slotNameContext = (0, _element.createContext)();
-
-const positionToPlacement = position => {
-  const [x, y, z] = position.split(' ');
-
-  if (['top', 'bottom'].includes(x)) {
-    let suffix = '';
-
-    if (!!z && z === 'left' || y === 'right') {
-      suffix = '-start';
-    } else if (!!z && z === 'right' || y === 'left') {
-      suffix = '-end';
-    }
-
-    return x + suffix;
-  }
-
-  return y;
-};
-
-const placementToAnimationOrigin = placement => {
-  const [a, b] = placement.split('-');
-  let x, y;
-
-  if (a === 'top' || a === 'bottom') {
-    x = a === 'top' ? 'bottom' : 'top';
-    y = 'middle';
-
-    if (b === 'start') {
-      y = 'left';
-    } else if (b === 'end') {
-      y = 'right';
-    }
-  }
-
-  if (a === 'left' || a === 'right') {
-    x = 'center';
-    y = a === 'left' ? 'right' : 'left';
-
-    if (b === 'start') {
-      x = 'top';
-    } else if (b === 'end') {
-      x = 'bottom';
-    }
+const SLOT_NAME = 'Popover'; // An SVG displaying a triangle facing down, filled with a solid
+// color and bordered in such a way to create an arrow-like effect.
+// Keeping the SVG's viewbox squared simplify the arrow positioning
+// calculations.
+
+const ArrowTriangle = props => (0, _element.createElement)(_primitives.SVG, (0, _extends2.default)({}, props, {
+  xmlns: "http://www.w3.org/2000/svg",
+  viewBox: `0 0 100 100`,
+  className: "components-popover__triangle",
+  role: "presentation"
+}), (0, _element.createElement)(_primitives.Path, {
+  className: "components-popover__triangle-bg",
+  d: "M 0 0 L 50 50 L 100 0"
+}), (0, _element.createElement)(_primitives.Path, {
+  className: "components-popover__triangle-border",
+  d: "M 0 0 L 50 50 L 100 0",
+  vectorEffect: "non-scaling-stroke"
+}));
+
+const MaybeAnimatedWrapper = (0, _element.forwardRef)((_ref, forwardedRef) => {
+  let {
+    style: receivedInlineStyles,
+    placement,
+    shouldAnimate = false,
+    ...props
+  } = _ref;
+  const shouldReduceMotion = (0, _framerMotion.useReducedMotion)();
+  const {
+    style: motionInlineStyles,
+    ...otherMotionProps
+  } = (0, _element.useMemo)(() => (0, _utils.placementToMotionAnimationProps)(placement), [placement]);
+
+  if (shouldAnimate && !shouldReduceMotion) {
+    return (0, _element.createElement)(_framerMotion.motion.div, (0, _extends2.default)({
+      style: { ...motionInlineStyles,
+        ...receivedInlineStyles
+      }
+    }, otherMotionProps, props, {
+      ref: forwardedRef
+    }));
   }
 
-  return x + ' ' + y;
-};
+  return (0, _element.createElement)("div", (0, _extends2.default)({
+    style: receivedInlineStyles
+  }, props, {
+    ref: forwardedRef
+  }));
+});
+const slotNameContext = (0, _element.createContext)();
 
-const Popover = (_ref, ref) => {
+const Popover = (_ref2, forwardedRef) => {
   let {
     range,
     animate = true,
@@ -109,8 +114,8 @@ const Popover = (_ref, ref) => {
     noArrow = true,
     isAlternate,
     position,
-    placement = 'bottom-start',
-    offset,
+    placement: placementProp = 'bottom-start',
+    offset: offsetProp = 0,
     focusOnMount = 'firstElement',
     anchorRef,
     anchorRect,
@@ -119,10 +124,10 @@ const Popover = (_ref, ref) => {
     onFocusOutside,
     __unstableSlotName = SLOT_NAME,
     __unstableObserveElement,
-    __unstableForcePosition,
+    __unstableForcePosition = false,
     __unstableShift = false,
     ...contentProps
-  } = _ref;
+  } = _ref2;
 
   if (range) {
     (0, _deprecated.default)('range prop in Popover component', {
@@ -136,69 +141,77 @@ const Popover = (_ref, ref) => {
   const isMobileViewport = (0, _compose.useViewportMatch)('medium', '<');
   const isExpanded = expandOnMobile && isMobileViewport;
   const hasArrow = !isExpanded && !noArrow;
-  const usedPlacement = position ? positionToPlacement(position) : placement;
-  const ownerDocument = (0, _element.useMemo)(() => {
+  const normalizedPlacementFromProps = position ? (0, _utils.positionToPlacement)(position) : placementProp;
+  const referenceOwnerDocument = (0, _element.useMemo)(() => {
+    var _documentToReturn;
+
+    let documentToReturn;
+
     if (anchorRef !== null && anchorRef !== void 0 && anchorRef.top) {
-      return anchorRef === null || anchorRef === void 0 ? void 0 : anchorRef.top.ownerDocument;
+      documentToReturn = anchorRef === null || anchorRef === void 0 ? void 0 : anchorRef.top.ownerDocument;
     } else if (anchorRef !== null && anchorRef !== void 0 && anchorRef.startContainer) {
-      return anchorRef.startContainer.ownerDocument;
+      documentToReturn = anchorRef.startContainer.ownerDocument;
     } else if (anchorRef !== null && anchorRef !== void 0 && anchorRef.current) {
-      return anchorRef.current.ownerDocument;
+      documentToReturn = anchorRef.current.ownerDocument;
     } else if (anchorRef) {
       // This one should be deprecated.
-      return anchorRef.ownerDocument;
+      documentToReturn = anchorRef.ownerDocument;
     } else if (anchorRect && anchorRect !== null && anchorRect !== void 0 && anchorRect.ownerDocument) {
-      return anchorRect.ownerDocument;
+      documentToReturn = anchorRect.ownerDocument;
     } else if (getAnchorRect) {
-      var _getAnchorRect$ownerD, _getAnchorRect;
+      var _getAnchorRect;
 
-      return (_getAnchorRect$ownerD = (_getAnchorRect = getAnchorRect(anchorRefFallback.current)) === null || _getAnchorRect === void 0 ? void 0 : _getAnchorRect.ownerDocument) !== null && _getAnchorRect$ownerD !== void 0 ? _getAnchorRect$ownerD : document;
+      documentToReturn = (_getAnchorRect = getAnchorRect(anchorRefFallback.current)) === null || _getAnchorRect === void 0 ? void 0 : _getAnchorRect.ownerDocument;
     }
 
-    return document;
+    return (_documentToReturn = documentToReturn) !== null && _documentToReturn !== void 0 ? _documentToReturn : document;
   }, [anchorRef, anchorRect, getAnchorRect]);
   /**
    * Offsets the position of the popover when the anchor is inside an iframe.
+   *
+   * Store the offset in a ref, due to constraints with floating-ui:
+   * https://floating-ui.com/docs/react-dom#variables-inside-middleware-functions.
    */
 
-  const frameOffset = (0, _element.useMemo)(() => {
-    const {
-      defaultView
-    } = ownerDocument;
-    const {
-      frameElement
-    } = defaultView;
+  const frameOffsetRef = (0, _element.useRef)((0, _utils.getFrameOffset)(referenceOwnerDocument));
+  /**
+   * Store the offset prop in a ref, due to constraints with floating-ui:
+   * https://floating-ui.com/docs/react-dom#variables-inside-middleware-functions.
+   */
 
-    if (!frameElement || ownerDocument === document) {
-      return undefined;
+  const offsetRef = (0, _element.useRef)(offsetProp);
+  const middleware = [(0, _reactDom.offset)(_ref3 => {
+    let {
+      placement: currentPlacement
+    } = _ref3;
+
+    if (!frameOffsetRef.current) {
+      return offsetRef.current;
     }
 
-    const iframeRect = frameElement.getBoundingClientRect();
-    return {
-      name: 'iframeOffset',
-
-      fn(_ref2) {
-        let {
-          x,
-          y
-        } = _ref2;
-        return {
-          x: x + iframeRect.left,
-          y: y + iframeRect.top
-        };
-      }
+    const isTopBottomPlacement = currentPlacement.includes('top') || currentPlacement.includes('bottom'); // The main axis should represent the gap between the
+    // floating element and the reference element. The cross
+    // axis is always perpendicular to the main axis.
+
+    const mainAxis = isTopBottomPlacement ? 'y' : 'x';
+    const crossAxis = mainAxis === 'x' ? 'y' : 'x'; // When the popover is before the reference, subtract the offset,
+    // of the main axis else add it.
 
+    const hasBeforePlacement = currentPlacement.includes('top') || currentPlacement.includes('left');
+    const mainAxisModifier = hasBeforePlacement ? -1 : 1;
+    return {
+      mainAxis: offsetRef.current + frameOffsetRef.current[mainAxis] * mainAxisModifier,
+      crossAxis: frameOffsetRef.current[crossAxis]
     };
-  }, [ownerDocument]);
-  const middlewares = [frameOffset, offset ? (0, _reactDom.offset)(offset) : undefined, __unstableForcePosition ? undefined : (0, _reactDom.flip)(), __unstableForcePosition ? undefined : (0, _reactDom.size)({
+  }), __unstableForcePosition ? undefined : (0, _reactDom.flip)(), __unstableForcePosition ? undefined : (0, _reactDom.size)({
     apply(sizeProps) {
       const {
-        height
+        availableHeight
       } = sizeProps;
       if (!refs.floating.current) return; // Reduce the height of the popover to the available space.
 
       Object.assign(refs.floating.current.firstChild.style, {
-        maxHeight: `${height}px`,
+        maxHeight: `${availableHeight}px`,
         overflow: 'auto'
       });
     }
@@ -215,16 +228,19 @@ const Popover = (_ref, ref) => {
   const slotName = (0, _element.useContext)(slotNameContext) || __unstableSlotName;
 
   const slot = (0, _slotFill.useSlot)(slotName);
-
-  const onDialogClose = (type, event) => {
-    // Ideally the popover should have just a single onClose prop and
-    // not three props that potentially do the same thing.
-    if (type === 'focus-outside' && onFocusOutside) {
-      onFocusOutside(event);
-    } else if (onClose) {
-      onClose();
-    }
-  };
+  let onDialogClose;
+
+  if (onClose || onFocusOutside) {
+    onDialogClose = (type, event) => {
+      // Ideally the popover should have just a single onClose prop and
+      // not three props that potentially do the same thing.
+      if (type === 'focus-outside' && onFocusOutside) {
+        onFocusOutside(event);
+      } else if (onClose) {
+        onClose();
+      }
+    };
+  }
 
   const [dialogRef, dialogProps] = (0, _compose.__experimentalUseDialog)({
     focusOnMount,
@@ -232,35 +248,46 @@ const Popover = (_ref, ref) => {
     onClose: onDialogClose
   });
   const {
+    // Positioning coordinates
     x,
     y,
+    // Callback refs (not regular refs). This allows the position to be updated.
+    // when either elements change.
     reference,
     floating,
-    strategy,
+    // Object with "regular" refs to both "reference" and "floating"
     refs,
+    // Type of CSS position property to use (absolute or fixed)
+    strategy,
     update,
-    placement: placementData,
+    placement: computedPlacement,
     middlewareData: {
       arrow: arrowData = {}
     }
   } = (0, _reactDom.useFloating)({
-    placement: usedPlacement,
-    middleware: middlewares
+    placement: normalizedPlacementFromProps,
+    middleware
   });
-  const staticSide = {
-    top: 'bottom',
-    right: 'left',
-    bottom: 'top',
-    left: 'right'
-  }[placementData.split('-')[0]];
-  const mergedRefs = (0, _compose.useMergeRefs)([floating, dialogRef, ref]); // Updates references
+  (0, _element.useEffect)(() => {
+    offsetRef.current = offsetProp;
+    update();
+  }, [offsetProp, update]); // Update the `reference`'s ref.
+  //
+  // In floating-ui's terms:
+  // - "reference" refers to the popover's anchor element.
+  // - "floating" refers the floating popover's element.
+  // A floating element can also be positioned relative to a virtual element,
+  // instead of a real one. A virtual element is represented by an object
+  // with the `getBoundingClientRect()` function (like real elements).
+  // See https://floating-ui.com/docs/virtual-elements for more info.
 
   (0, _element.useLayoutEffect)(() => {
-    // No ref or position have been passed
-    let usedRef;
+    let resultingReferenceRef;
 
     if (anchorRef !== null && anchorRef !== void 0 && anchorRef.top) {
-      usedRef = {
+      // Create a virtual element for the ref. The expectation is that
+      // if anchorRef.top is defined, then anchorRef.bottom is defined too.
+      resultingReferenceRef = {
         getBoundingClientRect() {
           const topRect = anchorRef.top.getBoundingClientRect();
           const bottomRect = anchorRef.bottom.getBoundingClientRect();
@@ -269,18 +296,23 @@ const Popover = (_ref, ref) => {
 
       };
     } else if (anchorRef !== null && anchorRef !== void 0 && anchorRef.current) {
-      usedRef = anchorRef.current;
+      // Standard React ref.
+      resultingReferenceRef = anchorRef.current;
     } else if (anchorRef) {
-      usedRef = anchorRef;
+      // If `anchorRef` holds directly the element's value (no `current` key)
+      // This is a weird scenario and should be deprecated.
+      resultingReferenceRef = anchorRef;
     } else if (anchorRect) {
-      usedRef = {
+      // Create a virtual element for the ref.
+      resultingReferenceRef = {
         getBoundingClientRect() {
           return anchorRect;
         }
 
       };
     } else if (getAnchorRect) {
-      usedRef = {
+      // Create a virtual element for the ref.
+      resultingReferenceRef = {
         getBoundingClientRect() {
           var _rect$x, _rect$y, _rect$width, _rect$height;
 
@@ -290,21 +322,25 @@ const Popover = (_ref, ref) => {
 
       };
     } else if (anchorRefFallback.current) {
-      usedRef = anchorRefFallback.current;
+      // If no explicit ref is passed via props, fall back to
+      // anchoring to the popover's parent node.
+      resultingReferenceRef = anchorRefFallback.current.parentNode;
     }
 
-    if (!usedRef) {
+    if (!resultingReferenceRef) {
       return;
     }
 
-    reference(usedRef);
+    reference(resultingReferenceRef);
 
     if (!refs.floating.current) {
       return;
     }
 
-    return (0, _reactDom.autoUpdate)(usedRef, refs.floating.current, update);
-  }, [anchorRef, anchorRect, getAnchorRect]); // This is only needed for a smoth transition when moving blocks.
+    return (0, _reactDom.autoUpdate)(resultingReferenceRef, refs.floating.current, update); // 'reference' and 'refs.floating' are refs and don't need to be listed
+    // as dependencies (see https://github.com/WordPress/gutenberg/pull/41612)
+    // eslint-disable-next-line react-hooks/exhaustive-deps
+  }, [anchorRef, anchorRect, getAnchorRect, update]); // This is only needed for a smooth transition when moving blocks.
 
   (0, _element.useLayoutEffect)(() => {
     if (!__unstableObserveElement) {
@@ -318,33 +354,57 @@ const Popover = (_ref, ref) => {
     return () => {
       observer.disconnect();
     };
-  }, [__unstableObserveElement]); // If we're using getAnchorRect, we need to update the position as we scroll the iframe.
+  }, [__unstableObserveElement, update]); // If the reference element is in a different ownerDocument (e.g. iFrame),
+  // we need to manually update the floating's position as the reference's owner
+  // document scrolls. Also update the frame offset if the view resizes.
 
   (0, _element.useLayoutEffect)(() => {
-    if (ownerDocument === document) {
+    var _referenceOwnerDocume;
+
+    if (referenceOwnerDocument === document) {
+      frameOffsetRef.current = undefined;
       return;
     }
 
-    ownerDocument.addEventListener('scroll', update);
-    return () => ownerDocument.removeEventListener('scroll', update);
-  }, [ownerDocument]);
-  /** @type {false | string} */
+    const {
+      defaultView
+    } = referenceOwnerDocument;
+    referenceOwnerDocument.addEventListener('scroll', update);
+    let updateFrameOffset;
+    const hasFrameElement = !!(referenceOwnerDocument !== null && referenceOwnerDocument !== void 0 && (_referenceOwnerDocume = referenceOwnerDocument.defaultView) !== null && _referenceOwnerDocume !== void 0 && _referenceOwnerDocume.frameElement);
+
+    if (hasFrameElement) {
+      updateFrameOffset = () => {
+        frameOffsetRef.current = (0, _utils.getFrameOffset)(referenceOwnerDocument);
+        update();
+      };
+
+      updateFrameOffset();
+      defaultView.addEventListener('resize', updateFrameOffset);
+    }
+
+    return () => {
+      referenceOwnerDocument.removeEventListener('scroll', update);
 
-  const animateClassName = !!animate && (0, _animate.getAnimateClassName)({
-    type: 'appear',
-    origin: placementToAnimationOrigin(placementData)
-  }); // Disable reason: We care to capture the _bubbled_ events from inputs
+      if (updateFrameOffset) {
+        defaultView.removeEventListener('resize', updateFrameOffset);
+      }
+    };
+  }, [referenceOwnerDocument, update]);
+  const mergedFloatingRef = (0, _compose.useMergeRefs)([floating, dialogRef, forwardedRef]); // Disable reason: We care to capture the _bubbled_ events from inputs
   // within popover as inferring close intent.
 
   let content = // eslint-disable-next-line jsx-a11y/no-noninteractive-element-interactions
   // eslint-disable-next-line jsx-a11y/no-static-element-interactions
-  (0, _element.createElement)("div", (0, _extends2.default)({
-    className: (0, _classnames.default)('components-popover', className, animateClassName, {
+  (0, _element.createElement)(MaybeAnimatedWrapper, (0, _extends2.default)({
+    shouldAnimate: animate && !isExpanded,
+    placement: computedPlacement,
+    className: (0, _classnames.default)('components-popover', className, {
       'is-expanded': isExpanded,
       'is-alternate': isAlternate
     })
   }, contentProps, {
-    ref: mergedRefs
+    ref: mergedFloatingRef
   }, dialogProps, {
     tabIndex: "-1",
     style: isExpanded ? undefined : {
@@ -363,16 +423,13 @@ const Popover = (_ref, ref) => {
   })), (0, _element.createElement)("div", {
     className: "components-popover__content"
   }, children), hasArrow && (0, _element.createElement)("div", {
-    className: "components-popover__arrow",
     ref: arrowRef,
+    className: ['components-popover__arrow', `is-${computedPlacement.split('-')[0]}`].join(' '),
     style: {
-      left: !(arrowData !== null && arrowData !== void 0 && arrowData.x) || Number.isNaN(arrowData === null || arrowData === void 0 ? void 0 : arrowData.x) ? 0 : arrowData.x,
-      top: !(arrowData !== null && arrowData !== void 0 && arrowData.y) || Number.isNaN(arrowData === null || arrowData === void 0 ? void 0 : arrowData.y) ? 0 : arrowData.y,
-      right: undefined,
-      bottom: undefined,
-      [staticSide]: '-4px'
+      left: Number.isFinite(arrowData === null || arrowData === void 0 ? void 0 : arrowData.x) ? `${arrowData.x}px` : '',
+      top: Number.isFinite(arrowData === null || arrowData === void 0 ? void 0 : arrowData.y) ? `${arrowData.y}px` : ''
     }
-  }));
+  }, (0, _element.createElement)(ArrowTriangle, null)));
 
   if (slot.ref) {
     content = (0, _element.createElement)(_slotFill.Fill, {
@@ -391,10 +448,10 @@ const Popover = (_ref, ref) => {
 
 const PopoverContainer = (0, _element.forwardRef)(Popover);
 
-function PopoverSlot(_ref3, ref) {
+function PopoverSlot(_ref4, ref) {
   let {
     name = SLOT_NAME
-  } = _ref3;
+  } = _ref4;
   return (0, _element.createElement)(_slotFill.Slot, {
     bubblesVirtually: true,
     name: name,