@sanity/ui 3.0.0-static.11 → 3.0.0-static.13

package/src/ui/primitives/popover/popover.tsx

@@ -3,22 +3,19 @@ import {
   autoUpdate,
   flip,
   hide,
-  Middleware,
+  type Middleware,
   offset,
-  RootBoundary,
+  type RootBoundary,
   shift,
   useFloating,
 } from '@floating-ui/react-dom'
 import {AnimatePresence} from 'framer-motion'
 import {
   cloneElement,
-  ForwardedRef,
-  forwardRef,
-  memo,
-  MutableRefObject,
-  ReactElement,
-  ReactNode,
-  RefCallback,
+  type ForwardedRef,
+  type ReactElement,
+  type ReactNode,
+  type Ref,
   useCallback,
   useEffect,
   useImperativeHandle,
@@ -29,9 +26,9 @@ import {
 import {Z_OFFSETS} from '../../constants'
 import {useArrayProp, usePrefersReducedMotion} from '../../hooks'
 import {origin} from '../../middleware/origin'
-import {Placement, PopoverMargins, Props} from '../../types'
-import {LayerProps, LayerProvider, Portal, useBoundaryElement, useLayer} from '../../utils'
-import {CardProps, CardProvider, useCard} from '../card'
+import type {ComponentType, Placement, PopoverMargins, Props} from '../../types'
+import {type LayerOwnProps, LayerProvider, Portal, useBoundaryElement, useLayer} from '../../utils'
+import {CardProvider, useCard} from '../card'
 import {
   DEFAULT_FALLBACK_PLACEMENTS,
   DEFAULT_POPOVER_DISTANCE,
@@ -40,10 +37,13 @@ import {
 } from './constants'
 import {size} from './floating-ui/size'
 import {PopoverCard} from './popoverCard'
-import {PopoverUpdateCallback} from './types'
+import type {PopoverUpdateCallback} from './types'
 
 /** @public */
-export interface PopoverProps extends CardProps, LayerProps {
+export const DEFAULT_POPOVER_ELEMENT = 'div'
+
+/** @public */
+export type PopoverOwnProps = LayerOwnProps & {
   /** @beta */
   __unstable_margins?: PopoverMargins
   /**
@@ -101,12 +101,19 @@ export interface PopoverProps extends CardProps, LayerProps {
    */
   referenceElement?: HTMLElement | null
   /** @beta */
-  updateRef?:
-    | MutableRefObject<PopoverUpdateCallback | undefined>
-    | RefCallback<PopoverUpdateCallback | undefined>
+  updateRef?: Ref<PopoverUpdateCallback | undefined>
 }
 
-const ViewportOverlay = () => {
+/** @public */
+export type PopoverElementType = 'div' | ComponentType
+
+/** @public */
+export type PopoverProps<E extends PopoverElementType = PopoverElementType> = Props<
+  PopoverOwnProps,
+  E
+>
+
+function ViewportOverlay() {
   const {zIndex} = useLayer()
 
   return (
@@ -127,289 +134,286 @@ const ViewportOverlay = () => {
  *
  * @public
  */
-export const Popover = memo(
-  forwardRef(function Popover(
-    props: Props<PopoverProps, 'div'>,
-    forwardedRef: ForwardedRef<HTMLDivElement>,
-  ): ReactElement {
-    const boundaryElementContext = useBoundaryElement()
-
-    const {
-      __unstable_margins: margins = DEFAULT_POPOVER_MARGINS,
-      animate: _animate = false,
-      arrow: arrowProp = false,
-      // eslint-disable-next-line @typescript-eslint/no-unused-vars
-      boundaryElement = boundaryElementContext.element,
-      children: childProp,
-      constrainSize = false,
-      content,
-      disabled,
-      fallbackPlacements = props.fallbackPlacements ??
-        DEFAULT_FALLBACK_PLACEMENTS[props.placement ?? 'bottom'],
-      matchReferenceWidth,
-      floatingBoundary = props.boundaryElement ?? boundaryElementContext.element,
-      modal,
-      // eslint-disable-next-line @typescript-eslint/no-unused-vars
-      onActivate,
-      open,
-      overflow = 'hidden',
-      padding,
-      placement: placementProp = 'bottom',
-      portal,
-      preventOverflow = true,
-      radius = 3,
-      referenceBoundary = props.boundaryElement ?? boundaryElementContext.element,
-      referenceElement,
-      scheme,
-      shadow = 3,
-      tone = 'inherit',
-      width: widthProp = 'auto',
-      zOffset: zOffsetProp = Z_OFFSETS.popover,
-      updateRef,
-      ...restProps
-    } = props
-
-    const card = useCard()
-
-    const prefersReducedMotion = usePrefersReducedMotion()
-    const animate = prefersReducedMotion ? false : _animate
-    const zOffset = useArrayProp(zOffsetProp)
-    const ref = useRef<HTMLDivElement | null>(null)
-    const arrowRef = useRef<HTMLDivElement | null>(null)
-    const rootBoundary: RootBoundary = 'viewport'
-
-    useImperativeHandle<HTMLDivElement | null, HTMLDivElement | null>(
-      forwardedRef,
-      () => ref.current,
-    )
-
-    // Keep track of reference element width (see `size` middleware below)
-    const referenceWidthRef = useRef<number>(undefined)
-
-    const middleware = useMemo(() => {
-      const ret: Middleware[] = []
-
-      // Flip the floating element when leaving the boundary box
-      if (constrainSize || preventOverflow) {
-        ret.push(
-          flip({
-            boundary: floatingBoundary || undefined,
-            fallbackPlacements,
-            padding: DEFAULT_POPOVER_PADDING,
-            rootBoundary,
-          }),
-        )
-      }
-
-      // Define distance between reference and floating element
-      ret.push(offset({mainAxis: DEFAULT_POPOVER_DISTANCE}))
-
-      // Track sizes
-      if (constrainSize || matchReferenceWidth) {
-        ret.push(
-          size({
-            apply({availableWidth, availableHeight, elements, referenceWidth}) {
-              // not fresh, so use refs
-
-              referenceWidthRef.current = referenceWidth
-
-              if (matchReferenceWidth) {
-                elements.floating.style.width = `${referenceWidth}px`
-              }
-
-              if (constrainSize) {
-                elements.floating.style.maxWidth = `${availableWidth}px`
-                elements.floating.style.maxHeight = `${availableHeight}px`
-              }
-            },
-            boundaryElement: floatingBoundary || undefined,
-            constrainSize,
-            margins,
-            matchReferenceWidth,
-            padding: DEFAULT_POPOVER_PADDING,
-          }),
-        )
-      }
+export function Popover<E extends PopoverElementType = typeof DEFAULT_POPOVER_ELEMENT>(
+  props: PopoverProps<E>,
+) {
+  const boundaryElementContext = useBoundaryElement()
+
+  const {
+    __unstable_margins: margins = DEFAULT_POPOVER_MARGINS,
+    animate: _animate = false,
+    arrow: arrowProp = false,
+    as: as = DEFAULT_POPOVER_ELEMENT,
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    boundaryElement = boundaryElementContext.element,
+    children: childProp,
+    constrainSize = false,
+    content,
+    disabled,
+    fallbackPlacements = props.fallbackPlacements ??
+      DEFAULT_FALLBACK_PLACEMENTS[props.placement ?? 'bottom'],
+    matchReferenceWidth,
+    floatingBoundary = props.boundaryElement ?? boundaryElementContext.element,
+    modal,
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    onActivate,
+    open,
+    overflow = 'hidden',
+    padding,
+    placement: placementProp = 'bottom',
+    portal,
+    preventOverflow = true,
+    radius = 3,
+    ref: forwardedRef,
+    referenceBoundary = props.boundaryElement ?? boundaryElementContext.element,
+    referenceElement,
+    scheme,
+    shadow = 3,
+    tone = 'inherit',
+    width: widthProp = 'auto',
+    zOffset: zOffsetProp = Z_OFFSETS.popover,
+    updateRef,
+    ...rest
+  } = props as PopoverProps<typeof DEFAULT_POPOVER_ELEMENT>
+
+  const card = useCard()
+
+  const prefersReducedMotion = usePrefersReducedMotion()
+  const animate = prefersReducedMotion ? false : _animate
+  const zOffset = useArrayProp(zOffsetProp)
+  const ref = useRef<HTMLDivElement | null>(null)
+  const arrowRef = useRef<HTMLDivElement | null>(null)
+  const rootBoundary: RootBoundary = 'viewport'
+
+  useImperativeHandle<HTMLDivElement | null, HTMLDivElement | null>(forwardedRef, () => ref.current)
+
+  // Keep track of reference element width (see `size` middleware below)
+  const referenceWidthRef = useRef<number>(undefined)
+
+  const middleware = useMemo(() => {
+    const ret: Middleware[] = []
+
+    // Flip the floating element when leaving the boundary box
+    if (constrainSize || preventOverflow) {
+      ret.push(
+        flip({
+          boundary: floatingBoundary || undefined,
+          fallbackPlacements,
+          padding: DEFAULT_POPOVER_PADDING,
+          rootBoundary,
+        }),
+      )
+    }
 
-      // Shift the popover so its sits within the boundary element
-      if (preventOverflow) {
-        ret.push(
-          shift({
-            boundary: floatingBoundary || undefined,
-            rootBoundary,
-            padding: DEFAULT_POPOVER_PADDING,
-          }),
-        )
-      }
+    // Define distance between reference and floating element
+    ret.push(offset({mainAxis: DEFAULT_POPOVER_DISTANCE}))
 
-      // Place arrow
-      if (arrowProp) {
-        ret.push(
-          arrow({
-            element: arrowRef,
-            padding: DEFAULT_POPOVER_PADDING,
-          }),
-        )
-      }
+    // Track sizes
+    if (constrainSize || matchReferenceWidth) {
+      ret.push(
+        size({
+          apply({availableWidth, availableHeight, elements, referenceWidth}) {
+            // not fresh, so use refs
+
+            referenceWidthRef.current = referenceWidth
+
+            if (matchReferenceWidth) {
+              elements.floating.style.width = `${referenceWidth}px`
+            }
+
+            if (constrainSize) {
+              elements.floating.style.maxWidth = `${availableWidth}px`
+              elements.floating.style.maxHeight = `${availableHeight}px`
+            }
+          },
+          boundaryElement: floatingBoundary || undefined,
+          constrainSize,
+          margins,
+          matchReferenceWidth,
+          padding: DEFAULT_POPOVER_PADDING,
+        }),
+      )
+    }
 
-      // Determine the origin to scale from.
-      // Must be placed after `@sanity/ui/size` and `shift` middleware.
-      if (animate) {
-        ret.push(origin)
-      }
+    // Shift the popover so its sits within the boundary element
+    if (preventOverflow) {
+      ret.push(
+        shift({
+          boundary: floatingBoundary || undefined,
+          rootBoundary,
+          padding: DEFAULT_POPOVER_PADDING,
+        }),
+      )
+    }
 
+    // Place arrow
+    if (arrowProp) {
       ret.push(
-        hide({
-          boundary: referenceBoundary || undefined,
+        arrow({
+          element: arrowRef,
           padding: DEFAULT_POPOVER_PADDING,
-          strategy: 'referenceHidden',
         }),
       )
+    }
 
-      return ret
-    }, [
-      animate,
-      arrowProp,
-      constrainSize,
-      fallbackPlacements,
-      floatingBoundary,
-      margins,
-      matchReferenceWidth,
-      preventOverflow,
-      referenceBoundary,
-    ])
-
-    const {x, y, middlewareData, placement, refs, strategy, update} = useFloating({
-      middleware,
-      placement: placementProp,
-      whileElementsMounted: autoUpdate,
-      elements: referenceElement
-        ? {
-            reference: referenceElement,
-          }
-        : undefined,
-    })
-
-    const referenceHidden = middlewareData.hide?.referenceHidden
-
-    const arrowX = middlewareData.arrow?.x
-    const arrowY = middlewareData.arrow?.y
-
-    const originX = middlewareData['@sanity/ui/origin']?.originX
-    const originY = middlewareData['@sanity/ui/origin']?.originY
-
-    const setArrow = useCallback((arrowEl: HTMLDivElement | null) => {
-      arrowRef.current = arrowEl
-    }, [])
-
-    const setFloating = useCallback(
-      (node: HTMLDivElement | null) => {
-        ref.current = node
-        refs.setFloating(node)
-      },
-      [refs],
+    // Determine the origin to scale from.
+    // Must be placed after `@sanity/ui/size` and `shift` middleware.
+    if (animate) {
+      ret.push(origin)
+    }
+
+    ret.push(
+      hide({
+        boundary: referenceBoundary || undefined,
+        padding: DEFAULT_POPOVER_PADDING,
+        strategy: 'referenceHidden',
+      }),
     )
 
-    const setReference = useCallback(
-      (node: HTMLElement | null) => {
-        refs.setReference(node)
+    return ret
+  }, [
+    animate,
+    arrowProp,
+    constrainSize,
+    fallbackPlacements,
+    floatingBoundary,
+    margins,
+    matchReferenceWidth,
+    preventOverflow,
+    referenceBoundary,
+  ])
+
+  const {x, y, middlewareData, placement, refs, strategy, update} = useFloating({
+    middleware,
+    placement: placementProp,
+    whileElementsMounted: autoUpdate,
+    elements: referenceElement
+      ? {
+          reference: referenceElement,
+        }
+      : undefined,
+  })
 
-        const childRef = getElementRef(childProp as any)
+  const referenceHidden = middlewareData.hide?.referenceHidden
 
-        if (typeof childRef === 'function') {
-          childRef(node)
-        } else if (childRef) {
-          childRef.current = node
-        }
-      },
-      [childProp, refs],
-    )
+  const arrowX = middlewareData.arrow?.x
+  const arrowY = middlewareData.arrow?.y
+
+  const originX = middlewareData['@sanity/ui/origin']?.originX
+  const originY = middlewareData['@sanity/ui/origin']?.originY
 
-    const child = useMemo(() => {
-      // If a reference element is defined, we don't need to clone the child
-      if (referenceElement) return childProp
+  const setArrow = useCallback((arrowEl: HTMLDivElement | null) => {
+    arrowRef.current = arrowEl
+  }, [])
 
-      if (!childProp) return null
+  const setFloating = useCallback(
+    (node: HTMLDivElement | null) => {
+      ref.current = node
+      refs.setFloating(node)
+    },
+    [refs],
+  )
 
-      return cloneElement(childProp, {ref: setReference})
-    }, [childProp, referenceElement, setReference])
+  const setReference = useCallback(
+    (node: HTMLElement | null) => {
+      refs.setReference(node)
 
-    useEffect(() => {
-      if (updateRef) {
-        if (typeof updateRef === 'function') {
-          updateRef(update)
-        } else if (updateRef) {
-          updateRef.current = update
-        }
+      const childRef = getElementRef(childProp as any)
+
+      if (typeof childRef === 'function') {
+        childRef(node)
+      } else if (childRef) {
+        childRef.current = node
       }
-    }, [update, updateRef])
+    },
+    [childProp, refs],
+  )
+
+  const child = useMemo(() => {
+    // If a reference element is defined, we don't need to clone the child
+    if (referenceElement) return childProp
 
-    if (disabled) {
-      return childProp || <></>
+    if (!childProp) return null
+
+    return cloneElement(childProp, {ref: setReference})
+  }, [childProp, referenceElement, setReference])
+
+  useEffect(() => {
+    if (updateRef) {
+      if (typeof updateRef === 'function') {
+        updateRef(update)
+      } else if (updateRef) {
+        updateRef.current = update
+      }
     }
+  }, [update, updateRef])
+
+  if (disabled) {
+    return childProp || <></>
+  }
+
+  const popover = (
+    <LayerProvider zOffset={zOffset}>
+      {/* Optional transparent blocking overlay at the top-most z-index layer. Must be positioned 
+      before the below popover card. */}
+      {modal && <ViewportOverlay />}
+
+      <PopoverCard
+        {...rest}
+        __unstable_margins={margins}
+        animate={animate}
+        arrow={arrowProp}
+        arrowRef={setArrow}
+        arrowX={arrowX}
+        arrowY={arrowY}
+        as={as}
+        hidden={referenceHidden}
+        maxWidth={widthProp}
+        overflow={overflow}
+        padding={padding}
+        placement={placement}
+        radius={radius}
+        ref={setFloating}
+        scheme={scheme}
+        shadow={shadow}
+        originX={originX}
+        originY={originY}
+        strategy={strategy}
+        x={x}
+        y={y}
+      >
+        {content}
+      </PopoverCard>
+    </LayerProvider>
+  )
 
-    const popover = (
-      <LayerProvider zOffset={zOffset}>
-        {/* Optional transparent blocking overlay at the top-most z-index layer. Must be positioned 
-        before the below popover card. */}
-        {modal && <ViewportOverlay />}
-
-        <PopoverCard
-          {...restProps}
-          __unstable_margins={margins}
-          animate={animate}
-          arrow={arrowProp}
-          arrowRef={setArrow}
-          arrowX={arrowX}
-          arrowY={arrowY}
-          hidden={referenceHidden}
-          maxWidth={widthProp}
-          overflow={overflow}
-          padding={padding}
-          placement={placement}
-          radius={radius}
-          ref={setFloating}
-          scheme={scheme}
-          shadow={shadow}
-          originX={originX}
-          originY={originY}
-          strategy={strategy}
-          x={x}
-          y={y}
+  const children =
+    open &&
+    (portal ? (
+      <Portal __unstable_name={typeof portal === 'string' ? portal : undefined}>
+        <CardProvider
+          tone={tone === 'inherit' ? (card?.tone ?? 'default') : tone}
+          scheme={scheme ?? 'light'}
         >
-          {content}
-        </PopoverCard>
-      </LayerProvider>
-    )
+          {popover}
+        </CardProvider>
+      </Portal>
+    ) : (
+      popover
+    ))
 
-    const children =
-      open &&
-      (portal ? (
-        <Portal __unstable_name={typeof portal === 'string' ? portal : undefined}>
-          <CardProvider
-            tone={tone === 'inherit' ? (card?.tone ?? 'default') : tone}
-            scheme={scheme ?? 'light'}
-          >
-            {popover}
-          </CardProvider>
-        </Portal>
-      ) : (
-        popover
-      ))
-
-    return (
-      <>
-        {/* the popover */}
-        {animate ? <AnimatePresence>{children}</AnimatePresence> : children}
-
-        {/* the referred element */}
-        {child}
-      </>
-    )
-  }),
-)
+  return (
+    <>
+      {/* the popover */}
+      {animate ? <AnimatePresence>{children}</AnimatePresence> : children}
+
+      {/* the referred element */}
+      {child}
+    </>
+  )
+}
 
-Popover.displayName = 'Memo(ForwardRef(Popover))'
+Popover.displayName = 'Popover'
 
 // Before React 19 accessing `element.props.ref` will throw a warning and suggest using `element.ref`
 // After React 19 accessing `element.ref` does the opposite.