@base-ui/react 1.1.0 → 1.3.0

package/esm/drawer/swipe-area/DrawerSwipeArea.js

@@ -0,0 +1,381 @@
+'use client';
+
+import * as React from 'react';
+import { useStableCallback } from '@base-ui/utils/useStableCallback';
+import { useTimeout } from '@base-ui/utils/useTimeout';
+import { useDialogRootContext } from "../../dialog/root/DialogRootContext.js";
+import { useRenderElement } from "../../utils/useRenderElement.js";
+import { createChangeEventDetails } from "../../utils/createBaseUIEventDetails.js";
+import { REASONS } from "../../utils/reasons.js";
+import { getDisplacement, getElementTransform, useSwipeDismiss } from "../../utils/useSwipeDismiss.js";
+import { DrawerPopupCssVars } from "../popup/DrawerPopupCssVars.js";
+import { DrawerPopupDataAttributes } from "../popup/DrawerPopupDataAttributes.js";
+import { DrawerBackdropCssVars } from "../backdrop/DrawerBackdropCssVars.js";
+import { useDrawerRootContext } from "../root/DrawerRootContext.js";
+import { useBaseUiId } from "../../utils/useBaseUiId.js";
+import { useTriggerRegistration } from "../../utils/popups/index.js";
+import { useDrawerProviderContext } from "../provider/DrawerProviderContext.js";
+import { DrawerSwipeAreaDataAttributes } from "./DrawerSwipeAreaDataAttributes.js";
+const DEFAULT_SWIPE_OPEN_RATIO = 0.5;
+const MIN_SWIPE_START_DISTANCE = 1;
+const VELOCITY_THRESHOLD = 0.1;
+const FALLBACK_SWIPE_OPEN_THRESHOLD = 40;
+const SWIPE_AREA_OPEN_HOOK = {
+  [DrawerSwipeAreaDataAttributes.open]: ''
+};
+const SWIPE_AREA_CLOSED_HOOK = {
+  [DrawerSwipeAreaDataAttributes.closed]: ''
+};
+const SWIPE_AREA_SWIPING_HOOK = {
+  [DrawerSwipeAreaDataAttributes.swiping]: ''
+};
+const SWIPE_AREA_DISABLED_HOOK = {
+  [DrawerSwipeAreaDataAttributes.disabled]: ''
+};
+const stateAttributesMapping = {
+  open(value) {
+    return value ? SWIPE_AREA_OPEN_HOOK : SWIPE_AREA_CLOSED_HOOK;
+  },
+  swiping(value) {
+    return value ? SWIPE_AREA_SWIPING_HOOK : null;
+  },
+  swipeDirection(value) {
+    return value ? {
+      [DrawerSwipeAreaDataAttributes.swipeDirection]: value
+    } : null;
+  },
+  disabled(value) {
+    return value ? SWIPE_AREA_DISABLED_HOOK : null;
+  }
+};
+const oppositeSwipeDirection = {
+  up: 'down',
+  down: 'up',
+  left: 'right',
+  right: 'left'
+};
+function resolveTouchAction(direction) {
+  return direction === 'left' || direction === 'right' ? 'pan-y' : 'pan-x';
+}
+
+/**
+ * An invisible area that listens for swipe gestures to open the drawer.
+ * Renders a `<div>` element.
+ *
+ * Documentation: [Base UI Drawer](https://base-ui.com/react/components/drawer)
+ */
+export const DrawerSwipeArea = /*#__PURE__*/React.forwardRef(function DrawerSwipeArea(componentProps, forwardedRef) {
+  const {
+    className,
+    render,
+    disabled = false,
+    swipeDirection: swipeDirectionProp,
+    ...elementProps
+  } = componentProps;
+  const {
+    store
+  } = useDialogRootContext();
+  const {
+    swipeDirection,
+    frontmostHeight
+  } = useDrawerRootContext();
+  const providerContext = useDrawerProviderContext(true);
+  const [swipeActive, setSwipeActive] = React.useState(false);
+  const releaseDismissTimeout = useTimeout();
+  const swipeAreaRef = React.useRef(null);
+  const swipeStartEventRef = React.useRef(null);
+  const openedBySwipeRef = React.useRef(false);
+  const dragDeltaRef = React.useRef({
+    x: 0,
+    y: 0
+  });
+  const closedOffsetRef = React.useRef(null);
+  const appliedSwipeStylesRef = React.useRef(false);
+  const popupTransitionRef = React.useRef(null);
+  const swipeAreaId = useBaseUiId(componentProps.id);
+  const registerTrigger = useTriggerRegistration(swipeAreaId, store);
+  const open = store.useState('open');
+  const resolvedSwipeDirection = swipeDirectionProp ?? oppositeSwipeDirection[swipeDirection];
+  const dismissDirection = oppositeSwipeDirection[resolvedSwipeDirection];
+  const enabled = !disabled && (!open || swipeActive);
+  const resetDragDelta = useStableCallback(() => {
+    dragDeltaRef.current.x = 0;
+    dragDeltaRef.current.y = 0;
+  });
+  function disableDismissForSwipe() {
+    releaseDismissTimeout.clear();
+    store.context.outsidePressEnabledRef.current = false;
+  }
+  function enableDismissAfterRelease() {
+    // Safari can dispatch outside-press for the same swipe-open gesture
+    // after release, so defer re-enabling dismissal to the next macrotask.
+    releaseDismissTimeout.start(0, () => {
+      store.context.outsidePressEnabledRef.current = true;
+    });
+  }
+  function resolvePopupSize() {
+    const popupElement = store.context.popupRef.current;
+    if (!popupElement) {
+      return null;
+    }
+    const isHorizontal = dismissDirection === 'left' || dismissDirection === 'right';
+    const size = isHorizontal ? popupElement.offsetWidth : popupElement.offsetHeight;
+    if (size <= 0) {
+      return null;
+    }
+    return size;
+  }
+  function resolveClosedOffset() {
+    const offset = resolvePopupSize();
+    if (offset == null) {
+      return null;
+    }
+    const popupElement = store.context.popupRef.current;
+    if (!popupElement) {
+      return offset;
+    }
+    const isHorizontal = dismissDirection === 'left' || dismissDirection === 'right';
+    const transform = getElementTransform(popupElement);
+    const transformOffset = isHorizontal ? transform.x : transform.y;
+    if (Number.isFinite(transformOffset) && Math.abs(transformOffset) > 0.5) {
+      return Math.min(offset, Math.abs(transformOffset));
+    }
+    return offset;
+  }
+  function resolveSwipeOpenThreshold() {
+    const popupSize = resolvePopupSize();
+    if (popupSize == null) {
+      return FALLBACK_SWIPE_OPEN_THRESHOLD;
+    }
+    return popupSize * DEFAULT_SWIPE_OPEN_RATIO;
+  }
+  function applySwipeMovement() {
+    if (!swipeActive) {
+      return;
+    }
+    const popupElement = store.context.popupRef.current;
+    if (!popupElement) {
+      return;
+    }
+    if (!store.select('open') || !store.select('mounted')) {
+      return;
+    }
+    if (closedOffsetRef.current == null) {
+      closedOffsetRef.current = resolveClosedOffset();
+    }
+    const closedOffset = closedOffsetRef.current;
+    if (!closedOffset || !Number.isFinite(closedOffset) || closedOffset <= 0) {
+      return;
+    }
+    const {
+      x,
+      y
+    } = dragDeltaRef.current;
+    const displacement = getDisplacement(resolvedSwipeDirection, x, y);
+    const clampedDisplacement = Math.max(0, displacement);
+    const dampedDisplacement = clampedDisplacement > closedOffset ? closedOffset + Math.sqrt(clampedDisplacement - closedOffset) : clampedDisplacement;
+    const remaining = closedOffset - dampedDisplacement;
+    const directionSign = dismissDirection === 'left' || dismissDirection === 'up' ? -1 : 1;
+    const movement = remaining * directionSign;
+    const isHorizontal = dismissDirection === 'left' || dismissDirection === 'right';
+    const movementX = isHorizontal ? movement : 0;
+    const movementY = isHorizontal ? 0 : movement;
+    const openProgress = Math.max(0, Math.min(1, clampedDisplacement / closedOffset));
+    const backdropProgress = Math.max(0, Math.min(1, 1 - openProgress));
+    popupElement.style.setProperty(DrawerPopupCssVars.swipeMovementX, `${movementX}px`);
+    popupElement.style.setProperty(DrawerPopupCssVars.swipeMovementY, `${movementY}px`);
+    popupElement.setAttribute(DrawerPopupDataAttributes.swiping, '');
+    if (popupTransitionRef.current === null) {
+      popupTransitionRef.current = popupElement.style.transition;
+    }
+    popupElement.style.transition = 'none';
+    const backdropElement = store.context.backdropRef.current;
+    if (backdropElement) {
+      backdropElement.setAttribute(DrawerPopupDataAttributes.swiping, '');
+      backdropElement.style.setProperty(DrawerBackdropCssVars.swipeProgress, `${backdropProgress}`);
+      if (openProgress > 0 && frontmostHeight > 0) {
+        backdropElement.style.setProperty(DrawerPopupCssVars.height, `${frontmostHeight}px`);
+      } else {
+        backdropElement.style.removeProperty(DrawerPopupCssVars.height);
+      }
+    }
+    providerContext?.visualStateStore.set({
+      swipeProgress: openProgress,
+      frontmostHeight: openProgress > 0 ? frontmostHeight : 0
+    });
+    appliedSwipeStylesRef.current = true;
+  }
+  const clearSwipeStyles = useStableCallback(() => {
+    const popupElement = store.context.popupRef.current;
+    if (popupElement && appliedSwipeStylesRef.current) {
+      popupElement.style.removeProperty(DrawerPopupCssVars.swipeMovementX);
+      popupElement.style.removeProperty(DrawerPopupCssVars.swipeMovementY);
+      popupElement.removeAttribute(DrawerPopupDataAttributes.swiping);
+    }
+    if (popupElement && popupTransitionRef.current !== null) {
+      popupElement.style.transition = popupTransitionRef.current;
+      popupTransitionRef.current = null;
+    }
+    const backdropElement = store.context.backdropRef.current;
+    if (backdropElement) {
+      backdropElement.removeAttribute(DrawerPopupDataAttributes.swiping);
+      backdropElement.style.setProperty(DrawerBackdropCssVars.swipeProgress, '0');
+      backdropElement.style.removeProperty(DrawerPopupCssVars.height);
+    }
+    providerContext?.visualStateStore.set({
+      swipeProgress: 0,
+      frontmostHeight: 0
+    });
+    appliedSwipeStylesRef.current = false;
+  });
+  function openDrawer(event) {
+    if (store.select('open')) {
+      return;
+    }
+    openedBySwipeRef.current = true;
+    store.setOpen(true, createChangeEventDetails(REASONS.swipe, event, swipeAreaRef.current ?? undefined));
+  }
+  function closeDrawer(event) {
+    if (!store.select('open')) {
+      return;
+    }
+    store.setOpen(false, createChangeEventDetails(REASONS.swipe, event, swipeAreaRef.current ?? undefined));
+  }
+  const swipe = useSwipeDismiss({
+    enabled,
+    directions: [resolvedSwipeDirection],
+    elementRef: swipeAreaRef,
+    trackDrag: false,
+    movementCssVars: {
+      x: DrawerPopupCssVars.swipeMovementX,
+      y: DrawerPopupCssVars.swipeMovementY
+    },
+    onSwipeStart(event) {
+      disableDismissForSwipe();
+      swipeStartEventRef.current = event;
+      openedBySwipeRef.current = false;
+      setSwipeActive(true);
+      resetDragDelta();
+    },
+    onProgress(_progress, details) {
+      if (!details) {
+        return;
+      }
+      if (!swipeStartEventRef.current) {
+        return;
+      }
+      dragDeltaRef.current.x = details.deltaX;
+      dragDeltaRef.current.y = details.deltaY;
+      if (details.direction !== resolvedSwipeDirection) {
+        return;
+      }
+      const displacement = getDisplacement(resolvedSwipeDirection, details.deltaX, details.deltaY);
+      if (displacement < MIN_SWIPE_START_DISTANCE && !openedBySwipeRef.current) {
+        return;
+      }
+      if (!openedBySwipeRef.current) {
+        openDrawer(swipeStartEventRef.current);
+      }
+      applySwipeMovement();
+    },
+    onRelease({
+      event,
+      direction,
+      deltaX,
+      deltaY,
+      releaseVelocityX,
+      releaseVelocityY
+    }) {
+      const displacement = getDisplacement(resolvedSwipeDirection, deltaX, deltaY);
+      const releaseVelocity = getDisplacement(resolvedSwipeDirection, releaseVelocityX, releaseVelocityY);
+      const threshold = resolveSwipeOpenThreshold();
+      const hasEnoughDistance = threshold != null && displacement >= threshold;
+      const hasEnoughVelocity = releaseVelocity >= VELOCITY_THRESHOLD;
+      const shouldOpen = threshold != null && direction === resolvedSwipeDirection && (hasEnoughDistance || hasEnoughVelocity) && !disabled;
+      if (shouldOpen) {
+        if (!store.select('open')) {
+          openDrawer(event);
+        }
+      } else if (openedBySwipeRef.current) {
+        closeDrawer(event);
+      }
+      swipeStartEventRef.current = null;
+      openedBySwipeRef.current = false;
+      setSwipeActive(false);
+      closedOffsetRef.current = null;
+      enableDismissAfterRelease();
+      resetDragDelta();
+      clearSwipeStyles();
+      return false;
+    }
+  });
+  const swipePointerProps = swipe.getPointerProps();
+  const swipeTouchProps = swipe.getTouchProps();
+  const resetSwipe = swipe.reset;
+  React.useEffect(() => {
+    if (!enabled) {
+      resetSwipe();
+      resetDragDelta();
+      clearSwipeStyles();
+      setSwipeActive(false);
+      openedBySwipeRef.current = false;
+      swipeStartEventRef.current = null;
+      closedOffsetRef.current = null;
+    }
+  }, [clearSwipeStyles, enabled, resetDragDelta, resetSwipe]);
+  React.useEffect(() => {
+    return () => {
+      store.context.outsidePressEnabledRef.current = true;
+    };
+  }, [store]);
+  const state = {
+    open,
+    swiping: swipe.swiping,
+    swipeDirection: resolvedSwipeDirection,
+    disabled
+  };
+  return useRenderElement('div', componentProps, {
+    state,
+    ref: [forwardedRef, swipeAreaRef, registerTrigger],
+    stateAttributesMapping,
+    props: [{
+      role: 'presentation',
+      'aria-hidden': true,
+      style: {
+        pointerEvents: !enabled ? 'none' : undefined,
+        touchAction: resolveTouchAction(resolvedSwipeDirection)
+      },
+      onPointerDown(event) {
+        if (event.pointerType === 'touch') {
+          return;
+        }
+        swipePointerProps.onPointerDown?.(event);
+        // Prevent native text selection/drag gestures from competing with swipe-open dragging.
+        if (event.cancelable) {
+          event.preventDefault();
+        }
+      },
+      onPointerMove(event) {
+        if (event.pointerType === 'touch') {
+          return;
+        }
+        swipePointerProps.onPointerMove?.(event);
+      },
+      onPointerUp(event) {
+        if (event.pointerType === 'touch') {
+          return;
+        }
+        swipePointerProps.onPointerUp?.(event);
+      },
+      onPointerCancel(event) {
+        if (event.pointerType === 'touch') {
+          return;
+        }
+        swipePointerProps.onPointerCancel?.(event);
+      }
+    }, swipeTouchProps, swipeAreaId ? {
+      id: swipeAreaId
+    } : undefined, elementProps]
+  });
+});
+if (process.env.NODE_ENV !== "production") DrawerSwipeArea.displayName = "DrawerSwipeArea";

package/esm/drawer/swipe-area/DrawerSwipeAreaDataAttributes.d.ts

@@ -0,0 +1,23 @@
+export declare enum DrawerSwipeAreaDataAttributes {
+  /**
+   * Present when the drawer is open.
+   */
+  open = "data-open",
+  /**
+   * Present when the drawer is closed.
+   */
+  closed = "data-closed",
+  /**
+   * Present when the swipe area is disabled.
+   */
+  disabled = "data-disabled",
+  /**
+   * Indicates the swipe direction.
+   * @type {'up' | 'down' | 'left' | 'right'}
+   */
+  swipeDirection = "data-swipe-direction",
+  /**
+   * Present when the drawer is being swiped.
+   */
+  swiping = "data-swiping",
+}

package/esm/drawer/swipe-area/DrawerSwipeAreaDataAttributes.js

@@ -0,0 +1,25 @@
+import { CommonPopupDataAttributes } from "../../utils/popupStateMapping.js";
+export let DrawerSwipeAreaDataAttributes = function (DrawerSwipeAreaDataAttributes) {
+  /**
+   * Present when the drawer is open.
+   */
+  DrawerSwipeAreaDataAttributes[DrawerSwipeAreaDataAttributes["open"] = CommonPopupDataAttributes.open] = "open";
+  /**
+   * Present when the drawer is closed.
+   */
+  DrawerSwipeAreaDataAttributes[DrawerSwipeAreaDataAttributes["closed"] = CommonPopupDataAttributes.closed] = "closed";
+  /**
+   * Present when the swipe area is disabled.
+   */
+  DrawerSwipeAreaDataAttributes["disabled"] = "data-disabled";
+  /**
+   * Indicates the swipe direction.
+   * @type {'up' | 'down' | 'left' | 'right'}
+   */
+  DrawerSwipeAreaDataAttributes["swipeDirection"] = "data-swipe-direction";
+  /**
+   * Present when the drawer is being swiped.
+   */
+  DrawerSwipeAreaDataAttributes["swiping"] = "data-swiping";
+  return DrawerSwipeAreaDataAttributes;
+}({});

package/esm/drawer/title/DrawerTitle.d.ts

@@ -0,0 +1,18 @@
+import type * as React from 'react';
+import type { BaseUIComponentProps } from "../../utils/types.js";
+/**
+ * A heading that labels the drawer.
+ * Renders an `<h2>` element.
+ *
+ * Documentation: [Base UI Drawer](https://base-ui.com/react/components/drawer)
+ */
+export declare const DrawerTitle: DrawerTitle;
+export interface DrawerTitleProps extends BaseUIComponentProps<'h2', DrawerTitleState> {}
+export interface DrawerTitleState {}
+export interface DrawerTitle {
+  (componentProps: DrawerTitleProps): React.JSX.Element;
+}
+export declare namespace DrawerTitle {
+  type Props = DrawerTitleProps;
+  type State = DrawerTitleState;
+}

package/esm/drawer/title/DrawerTitle.js

@@ -0,0 +1,10 @@
+'use client';
+
+import { DialogTitle } from "../../dialog/title/DialogTitle.js";
+/**
+ * A heading that labels the drawer.
+ * Renders an `<h2>` element.
+ *
+ * Documentation: [Base UI Drawer](https://base-ui.com/react/components/drawer)
+ */
+export const DrawerTitle = DialogTitle;

package/esm/drawer/trigger/DrawerTrigger.d.ts

@@ -0,0 +1,43 @@
+import type * as React from 'react';
+import type { DialogHandle as DrawerHandle } from "../../dialog/store/DialogHandle.js";
+import type { BaseUIComponentProps, NativeButtonProps } from "../../utils/types.js";
+/**
+ * A button that opens the drawer.
+ * Renders a `<button>` element.
+ *
+ * Documentation: [Base UI Drawer](https://base-ui.com/react/components/drawer)
+ */
+export declare const DrawerTrigger: DrawerTrigger;
+export interface DrawerTrigger {
+  <Payload>(componentProps: DrawerTriggerProps<Payload> & React.RefAttributes<HTMLElement>): React.JSX.Element;
+}
+export interface DrawerTriggerProps<Payload = unknown> extends NativeButtonProps, BaseUIComponentProps<'button', DrawerTriggerState> {
+  /**
+   * A handle to associate the trigger with a drawer.
+   * Can be created with the Drawer.createHandle() method.
+   */
+  handle?: DrawerHandle<Payload> | undefined;
+  /**
+   * A payload to pass to the drawer when it is opened.
+   */
+  payload?: Payload | undefined;
+  /**
+   * ID of the trigger. In addition to being forwarded to the rendered element,
+   * it is also used to specify the active trigger for drawers in controlled mode (with the Drawer.Root `triggerId` prop).
+   */
+  id?: string | undefined;
+}
+export interface DrawerTriggerState {
+  /**
+   * Whether the drawer is currently disabled.
+   */
+  disabled: boolean;
+  /**
+   * Whether the drawer is currently open.
+   */
+  open: boolean;
+}
+export declare namespace DrawerTrigger {
+  type Props<Payload = unknown> = DrawerTriggerProps<Payload>;
+  type State = DrawerTriggerState;
+}

package/esm/drawer/trigger/DrawerTrigger.js

@@ -0,0 +1,10 @@
+'use client';
+
+import { DialogTrigger } from "../../dialog/trigger/DialogTrigger.js";
+/**
+ * A button that opens the drawer.
+ * Renders a `<button>` element.
+ *
+ * Documentation: [Base UI Drawer](https://base-ui.com/react/components/drawer)
+ */
+export const DrawerTrigger = DialogTrigger;

package/esm/drawer/viewport/DrawerViewport.d.ts

@@ -0,0 +1,33 @@
+import * as React from 'react';
+import type { BaseUIComponentProps } from "../../utils/types.js";
+import type { TransitionStatus } from "../../utils/useTransitionStatus.js";
+/**
+ * A positioning container for the drawer popup that can be made scrollable.
+ * Renders a `<div>` element.
+ *
+ * Documentation: [Base UI Drawer](https://base-ui.com/react/components/drawer)
+ */
+export declare const DrawerViewport: React.ForwardRefExoticComponent<Omit<DrawerViewportProps, "ref"> & React.RefAttributes<HTMLDivElement>>;
+export interface DrawerViewportState {
+  /**
+   * Whether the drawer is currently open.
+   */
+  open: boolean;
+  /**
+   * The transition status of the component.
+   */
+  transitionStatus: TransitionStatus;
+  /**
+   * Whether the drawer is nested within another drawer.
+   */
+  nested: boolean;
+  /**
+   * Whether the drawer has nested drawers open.
+   */
+  nestedDialogOpen: boolean;
+}
+export interface DrawerViewportProps extends BaseUIComponentProps<'div', DrawerViewportState> {}
+export declare namespace DrawerViewport {
+  type Props = DrawerViewportProps;
+  type State = DrawerViewportState;
+}