@jobber/components 9.5.3 → 9.6.0

package/dist/DrawerDescription-cjs.js

@@ -26,10 +26,223 @@ function _interopNamespaceDefault(e) {
 
 var React__namespace = /*#__PURE__*/_interopNamespaceDefault(React);
 
-const stateAttributesMapping$1 = {
-  ...useScrollLock.popupStateMapping,
-  ...useScrollLock.transitionStatusMapping
-};
+/**
+ * Minimal store contract exposed by popup handles to detached triggers.
+ *
+ * Detached triggers read `store` during render and subscribe to be notified when the handle switches
+ * between its fallback store and a root's live store.
+ *
+ * @template HandleStore Store shape exposed to detached triggers.
+ */
+
+/**
+ * Store shape holding a trigger registry, required by `BasePopupHandle.openByTrigger` to resolve a
+ * trigger element by id on both the attached root's store and the fallback store.
+ */
+
+/**
+ * Store shape required by `BasePopupHandle.openByTrigger`/`closePopup` to drive open/close state.
+ * Only the root-owned `Store` needs this — the `HandleStore` view exposed to detached triggers may
+ * omit `setOpen` entirely (as Dialog and PreviewCard's do) since it is never called while detached.
+ */
+
+/**
+ * Shared implementation for popup handles that coordinate detached triggers with a mounted root.
+ *
+ * Subclasses provide the component-specific imperative methods, while this base class owns the
+ * fallback store, root store attachment stack, subscriber notifications, and development warning for
+ * overlapping roots.
+ *
+ * @template HandleStore Store shape exposed to detached triggers.
+ * @template Store Root-owned store attached by the component root.
+ */
+class BasePopupHandle {
+  /**
+   * Stores of every root currently using this handle, in attach order. A handle is meant to be used
+   * by a single mounted root, but roots can transiently overlap (e.g. during an animated route
+   * transition), so this stack lets `attachStore`'s cleanup restore the previous root instead of
+   * leaving a still-mounted root uncontrollable when a newer overlapping root detaches first.
+   */
+  attachedStores = [];
+
+  /**
+   * Store of the root that currently controls the handle: the most recently attached one still
+   * mounted, or `null` when no root is attached. Imperative methods are no-ops while this is `null`.
+   */
+  attachedStoreValue = null;
+
+  /**
+   * Listeners notified when `attachedStore` changes, so detached triggers can follow the store pointer.
+   */
+  storeListeners = new Set();
+
+  /**
+   * Creates a handle backed by the store used while no root is attached.
+   *
+   * @param fallbackStore Inert, closed store handed to detached triggers while no root is attached,
+   * so they can render and register without a mounted root. Triggers register into whichever store
+   * `store` currently resolves to, so while detached they live in this store's trigger map and
+   * migrate themselves to the root's store (and back) as it attaches/detaches.
+   * @param componentName Component name used to prefix dev warnings, e.g. `'Menu'` produces
+   * `MenuHandle.open()` in warning text.
+   * @param throwOnMissingTrigger Whether `open(triggerId)` throws when no trigger with that id is
+   * registered. Anchored popups (Menu, Popover, Tooltip, PreviewCard) need a trigger to anchor to,
+   * so they throw; Dialog is not anchored and instead opens unassociated with a dev warning.
+   */
+  constructor(fallbackStore, componentName, throwOnMissingTrigger = true) {
+    this.fallbackStore = fallbackStore;
+    this.componentName = componentName;
+    this.throwOnMissingTrigger = throwOnMissingTrigger;
+  }
+  get attachedStore() {
+    return this.attachedStoreValue;
+  }
+
+  /**
+   * Store that detached triggers read from: the attached root's store, or an inert fallback store
+   * used while no root is attached.
+   * @internal
+   */
+  get store() {
+    return this.attachedStoreValue ?? this.fallbackStore;
+  }
+
+  /**
+   * Stable fallback store used for server rendering and hydration. Root stores cannot be recorded on
+   * the handle during render because a handle can be shared by concurrent server-rendered requests.
+   * @internal
+   */
+  get serverStore() {
+    return this.fallbackStore;
+  }
+
+  /**
+   * Subscribes to changes of the attached store pointer so detached triggers re-render and re-bind
+   * when a root attaches or detaches. Returns a function that removes the listener.
+   * @internal
+   */
+  subscribeStore(listener) {
+    this.storeListeners.add(listener);
+    return () => {
+      this.storeListeners.delete(listener);
+    };
+  }
+
+  /**
+   * Points the handle at a root's store and notifies subscribers so detached triggers re-render and
+   * re-register into it (their registration ref re-fires on the store-pointer change). Returns a
+   * cleanup function that detaches the store again.
+   * @internal
+   */
+  attachStore(newStore) {
+    this.attachedStores.push(newStore);
+    this.setActiveStore(newStore);
+    if (process.env.NODE_ENV !== 'production') {
+      if (this.attachedStores.length > 1) {
+        // More than one root is attached at once. This is usually a transient overlap during an
+        // animated route transition, where the outgoing root unmounts shortly after the incoming
+        // one mounts. Defer the check by a frame and only warn if the overlap is still present once
+        // the transition has settled (more than one root stayed mounted), so a clean handoff doesn't
+        // warn regardless of the exact unmount timing.
+        // The warning frame only exists in development; it is created lazily so it never appears on
+        // instances in production (like `controlledValues` in `ReactStore`).
+        const dev = this;
+        (dev.overlapWarningFrame ??= useScrollLock.AnimationFrame.create()).request(() => {
+          if (this.attachedStores.length > 1) {
+            console.warn('Base UI: A handle is attached to more than one mounted root at the same time. ' + 'The most recently mounted root takes over and the previous one stops being controlled by the handle. ' + 'A handle should be used by a single root that stays mounted for the lifetime of the handle.');
+          }
+        });
+      }
+    }
+    return () => {
+      const index = this.attachedStores.lastIndexOf(newStore);
+      if (index !== -1) {
+        this.attachedStores.splice(index, 1);
+      }
+      // Restore control to the most recently attached root that is still mounted (or detach fully if
+      // none remain). Clearing unconditionally would leave a still-mounted older root uncontrollable
+      // when a newer overlapping root detaches first (e.g. a canceled route transition).
+      this.setActiveStore(this.attachedStores[this.attachedStores.length - 1] ?? null);
+    };
+  }
+
+  /**
+   * Sets the store that currently controls the handle and notifies subscribers when it changes, so
+   * detached triggers re-render and migrate their registration to the new store.
+   */
+  setActiveStore(store) {
+    if (this.attachedStoreValue !== store) {
+      this.attachedStoreValue = store;
+      this.storeListeners.forEach(listener => {
+        listener();
+      });
+    }
+  }
+
+  /**
+   * Opens the attached root's store and associates it with the trigger with the given id, or a
+   * no-op (with a dev warning) while no root is attached. Shared by every concrete handle's public
+   * `open()` method, which only narrows the parameter type.
+   *
+   * When a trigger id is given but no matching trigger is registered, anchored popups throw (see
+   * `throwOnMissingTrigger`); Dialog opens unassociated with a dev warning instead.
+   *
+   * This method should only be called in an event handler or an effect (not during rendering).
+   *
+   * @param triggerId ID of the trigger to associate with the popup, or `null`/`undefined` to open
+   * without associating any trigger.
+   */
+  openByTrigger(triggerId) {
+    const attachedStore = this.attachedStore;
+    if (attachedStore === null) {
+      if (process.env.NODE_ENV !== 'production') {
+        console.warn(`Base UI: ${this.componentName}Handle.open() was called while no root using this handle is mounted. ` + 'The call was ignored; mount a root with this handle before opening it imperatively.');
+      }
+      return;
+    }
+
+    // Registered triggers normally live in the active root's store. During the commit in which a
+    // root attaches, a still-mounted detached trigger has not re-registered into that store yet (it
+    // migrates on its next render): it is still registered wherever it lived before — the fallback
+    // store when this is the first root to attach, or a previously attached root's store during a
+    // transient overlap (e.g. an animated route transition). Search the whole attachment stack
+    // (newest first) and the fallback map so an imperative open-by-id called in that commit (e.g.
+    // from a layout effect) still resolves the trigger instead of treating it as missing.
+    let triggerElement;
+    if (triggerId) {
+      for (let i = this.attachedStores.length - 1; i >= 0 && !triggerElement; i -= 1) {
+        triggerElement = this.attachedStores[i].context.triggerElements.getById(triggerId);
+      }
+      triggerElement ??= this.fallbackStore.context.triggerElements.getById(triggerId);
+    }
+    if (triggerId && !triggerElement) {
+      if (this.throwOnMissingTrigger) {
+        throw new Error(process.env.NODE_ENV !== "production" ? `Base UI: ${this.componentName}Handle.open() was called with the trigger id "${triggerId}", ` + 'but no matching trigger is registered with this handle. ' + 'An anchored popup cannot open without a trigger to anchor to. ' + `Pass the id of a mounted ${this.componentName}.Trigger that has this handle set on its "handle" prop.` : useRenderElement.formatErrorMessage(99, this.componentName, triggerId, this.componentName));
+      }
+      if (process.env.NODE_ENV !== 'production') {
+        console.warn(`Base UI: ${this.componentName}Handle.open: No trigger found with id "${triggerId}". ` + 'The popup will open, but the trigger will not be associated with it.');
+      }
+    }
+    attachedStore.setOpen(true, useScrollLock.createChangeEventDetails(useScrollLock.imperativeAction, undefined, triggerElement));
+  }
+
+  /**
+   * Closes the popup by setting the attached root's store to closed, or a no-op (with a dev warning)
+   * while no root is attached. Shared by every concrete handle's public `close()` method.
+   *
+   * This method should only be called in an event handler or an effect (not during rendering).
+   */
+  closePopup() {
+    const attachedStore = this.attachedStore;
+    if (attachedStore === null) {
+      if (process.env.NODE_ENV !== 'production') {
+        console.warn(`Base UI: ${this.componentName}Handle.close() was called while no root using this handle is mounted. ` + 'The call was ignored.');
+      }
+      return;
+    }
+    attachedStore.setOpen(false, useScrollLock.createChangeEventDetails(useScrollLock.imperativeAction));
+  }
+}
 
 /**
  * An overlay displayed beneath the popup.
@@ -45,9 +258,7 @@ const DialogBackdrop = /*#__PURE__*/React__namespace.forwardRef(function DialogB
     forceRender = false,
     ...elementProps
   } = componentProps;
-  const {
-    store
-  } = ScrollAreaViewport.useDialogRootContext();
+  const store = ScrollAreaViewport.useDialogRootContext();
   const open = store.useState('open');
   const nested = store.useState('nested');
   const mounted = store.useState('mounted');
@@ -59,7 +270,7 @@ const DialogBackdrop = /*#__PURE__*/React__namespace.forwardRef(function DialogB
   return useRenderElement.useRenderElement('div', componentProps, {
     state,
     ref: [store.context.backdropRef, forwardedRef],
-    stateAttributesMapping: stateAttributesMapping$1,
+    stateAttributesMapping: useScrollLock.popupTransitionStateMapping,
     props: [{
       role: 'presentation',
       hidden: !mounted,
@@ -87,9 +298,7 @@ const DialogDescription = /*#__PURE__*/React__namespace.forwardRef(function Dial
     id: idProp,
     ...elementProps
   } = componentProps;
-  const {
-    store
-  } = ScrollAreaViewport.useDialogRootContext();
+  const store = ScrollAreaViewport.useDialogRootContext();
   const id = useScrollLock.useBaseUiId(idProp);
   store.useSyncedValueWithCleanup('descriptionElementId', id);
   return useRenderElement.useRenderElement('p', componentProps, {
@@ -101,59 +310,6 @@ const DialogDescription = /*#__PURE__*/React__namespace.forwardRef(function Dial
 });
 if (process.env.NODE_ENV !== "production") DialogDescription.displayName = "DialogDescription";
 
-let DialogPopupCssVars = /*#__PURE__*/function (DialogPopupCssVars) {
-  /**
-   * Indicates how many dialogs are nested within.
-   * @type {number}
-   */
-  DialogPopupCssVars["nestedDialogs"] = "--nested-dialogs";
-  return DialogPopupCssVars;
-}({});
-
-let DialogPopupDataAttributes = function (DialogPopupDataAttributes) {
-  /**
-   * Present when the dialog is open.
-   */
-  DialogPopupDataAttributes[DialogPopupDataAttributes["open"] = useScrollLock.CommonPopupDataAttributes.open] = "open";
-  /**
-   * Present when the dialog is closed.
-   */
-  DialogPopupDataAttributes[DialogPopupDataAttributes["closed"] = useScrollLock.CommonPopupDataAttributes.closed] = "closed";
-  /**
-   * Present when the dialog is animating in.
-   */
-  DialogPopupDataAttributes[DialogPopupDataAttributes["startingStyle"] = useScrollLock.CommonPopupDataAttributes.startingStyle] = "startingStyle";
-  /**
-   * Present when the dialog is animating out.
-   */
-  DialogPopupDataAttributes[DialogPopupDataAttributes["endingStyle"] = useScrollLock.CommonPopupDataAttributes.endingStyle] = "endingStyle";
-  /**
-   * Present when the dialog is nested within another dialog.
-   */
-  DialogPopupDataAttributes["nested"] = "data-nested";
-  /**
-   * Present when the dialog has other open dialogs nested within it.
-   */
-  DialogPopupDataAttributes["nestedDialogOpen"] = "data-nested-dialog-open";
-  return DialogPopupDataAttributes;
-}({});
-
-const stateAttributesMapping = {
-  ...useScrollLock.popupStateMapping,
-  ...useScrollLock.transitionStatusMapping,
-  nestedDialogOpen(value) {
-    return value ? {
-      [DialogPopupDataAttributes.nestedDialogOpen]: ''
-    } : null;
-  }
-};
-
-/**
- * A container for the dialog contents.
- * Renders a `<div>` element.
- *
- * Documentation: [Base UI Dialog](https://base-ui.com/react/components/dialog)
- */
 const DialogPopup = /*#__PURE__*/React__namespace.forwardRef(function DialogPopup(componentProps, forwardedRef) {
   const {
     render,
@@ -163,9 +319,7 @@ const DialogPopup = /*#__PURE__*/React__namespace.forwardRef(function DialogPopu
     initialFocus,
     ...elementProps
   } = componentProps;
-  const {
-    store
-  } = ScrollAreaViewport.useDialogRootContext();
+  const store = ScrollAreaViewport.useDialogRootContext();
   const descriptionElementId = store.useState('descriptionElementId');
   const disablePointerDismissal = store.useState('disablePointerDismissal');
   const floatingRootContext = store.useState('floatingRootContext');
@@ -180,7 +334,6 @@ const DialogPopup = /*#__PURE__*/React__namespace.forwardRef(function DialogPopu
   const transitionStatus = store.useState('transitionStatus');
   const role = store.useState('role');
   const floatingId = floatingRootContext.useState('floatingId');
-  const popupId = elementProps.id ?? floatingId;
   ScrollAreaViewport.useDialogPortalContext();
   useScrollLock.useOpenChangeComplete({
     open,
@@ -203,9 +356,9 @@ const DialogPopup = /*#__PURE__*/React__namespace.forwardRef(function DialogPopu
   const element = useRenderElement.useRenderElement('div', componentProps, {
     state,
     props: [rootPopupProps, {
-      id: popupId,
-      'aria-labelledby': titleElementId ?? undefined,
-      'aria-describedby': descriptionElementId ?? undefined,
+      id: floatingId,
+      'aria-labelledby': titleElementId,
+      'aria-describedby': descriptionElementId,
       role,
       ...useScrollLock.FOCUSABLE_POPUP_PROPS,
       hidden: !mounted,
@@ -215,11 +368,11 @@ const DialogPopup = /*#__PURE__*/React__namespace.forwardRef(function DialogPopu
         }
       },
       style: {
-        [DialogPopupCssVars.nestedDialogs]: nestedOpenDialogCount
+        '--nested-dialogs': nestedOpenDialogCount
       }
     }, elementProps],
     ref: [forwardedRef, store.context.popupRef, setPopupElement],
-    stateAttributesMapping
+    stateAttributesMapping: ScrollAreaViewport.dialogStateAttributesMapping
   });
   return /*#__PURE__*/jsxRuntime.jsx(useScrollLock.FloatingFocusManager, {
     context: floatingRootContext,
@@ -236,59 +389,73 @@ const DialogPopup = /*#__PURE__*/React__namespace.forwardRef(function DialogPopu
 if (process.env.NODE_ENV !== "production") DialogPopup.displayName = "DialogPopup";
 
 /**
- * A handle to control a Dialog imperatively and to associate detached triggers with it.
+ * Groups all parts of the dialog.
+ * Doesn't render its own HTML element.
+ *
+ * Documentation: [Base UI Dialog](https://base-ui.com/react/components/dialog)
  */
-class DialogHandle {
-  /**
-   * Internal store holding the dialog state.
-   * @internal
-   */
+function DialogRoot(props) {
+  return ScrollAreaViewport.useRenderDialogRoot('dialog', props);
+}
 
-  constructor(store) {
-    this.store = store ?? new ScrollAreaViewport.DialogStore();
+/**
+ * Controls a Dialog imperatively and associates detached `Dialog.Trigger` components with a
+ * `Dialog.Root`. Create one with `Dialog.createHandle()` and pass it to the `handle` prop of the
+ * root and of any triggers rendered outside of it.
+ *
+ * The imperative methods take effect only while a root using this handle is mounted; calls made
+ * before a root attaches (or after it unmounts) are ignored.
+ */
+class DialogHandle extends BasePopupHandle {
+  constructor() {
+    super(ScrollAreaViewport.createNullDialogStore(), 'Dialog', false);
   }
 
   /**
-   * Opens the dialog and associates it with the trigger with the given id.
-   * The trigger, if provided, must be a matching Trigger component with this handle passed as a prop.
+   * Opens the dialog, optionally associating it with a trigger.
    *
    * This method should only be called in an event handler or an effect (not during rendering).
    *
-   * @param triggerId ID of the trigger to associate with the dialog. If null, the dialog will open without a trigger association.
+   * @param triggerId ID of the trigger to associate with the dialog. The trigger must be a matching
+   * `Dialog.Trigger` with this handle passed as a prop. Pass `null` to open without associating any trigger.
    */
   open(triggerId) {
-    const triggerElement = triggerId ? this.store.context.triggerElements.getById(triggerId) : undefined;
-    if (process.env.NODE_ENV !== 'production') {
-      if (triggerId && !triggerElement) {
-        console.warn(`Base UI: DialogHandle.open: No trigger found with id "${triggerId}". The dialog will open, but the trigger will not be associated with the dialog.`);
-      }
-    }
-    this.store.setOpen(true, useScrollLock.createChangeEventDetails(useScrollLock.imperativeAction, undefined, triggerElement));
+    this.openByTrigger(triggerId);
   }
 
   /**
-   * Opens the dialog and sets the payload.
-   * Does not associate the dialog with any trigger.
+   * Opens the dialog with the given payload, without associating it with any trigger.
+   *
+   * This method should only be called in an event handler or an effect (not during rendering).
    *
-   * @param payload Payload to set when opening the dialog.
+   * @param payload Payload to set when opening the dialog. It is exposed to the root's render-prop children.
    */
   openWithPayload(payload) {
-    this.store.set('payload', payload);
-    this.store.setOpen(true, useScrollLock.createChangeEventDetails(useScrollLock.imperativeAction, undefined, undefined));
+    const attachedStore = this.attachedStore;
+    if (attachedStore === null) {
+      if (process.env.NODE_ENV !== 'production') {
+        console.warn('Base UI: DialogHandle.openWithPayload() was called while no root using this handle is mounted. ' + 'The call and its payload were ignored; mount a root with this handle before opening it imperatively.');
+      }
+      return;
+    }
+    attachedStore.set('payload', payload);
+    attachedStore.setOpen(true, useScrollLock.createChangeEventDetails(useScrollLock.imperativeAction));
   }
 
   /**
    * Closes the dialog.
+   *
+   * This method should only be called in an event handler or an effect (not during rendering).
    */
   close() {
-    this.store.setOpen(false, useScrollLock.createChangeEventDetails(useScrollLock.imperativeAction, undefined, undefined));
+    this.closePopup();
   }
 
   /**
-   * Indicates whether the dialog is currently open.
+   * Whether the dialog is currently open. Returns `false` while no root is attached to the handle.
    */
   get isOpen() {
-    return this.store.select('open');
+    return this.attachedStore?.select('open') ?? false;
   }
 }
 
@@ -307,9 +474,11 @@ function createDialogHandle() {
  */
 const DrawerDescription = DialogDescription;
 
+exports.BasePopupHandle = BasePopupHandle;
 exports.DialogBackdrop = DialogBackdrop;
 exports.DialogDescription = DialogDescription;
 exports.DialogHandle = DialogHandle;
 exports.DialogPopup = DialogPopup;
+exports.DialogRoot = DialogRoot;
 exports.DrawerDescription = DrawerDescription;
 exports.createDialogHandle = createDialogHandle;