fix: use the nearest dialog manager to display dialogs (#2865)

MartinCupela · web-flow · commit e4081c832649 · 2025-10-17T10:40:16.000+02:00
diff --git a/src/components/Dialog/ButtonWithSubmenu.tsx b/src/components/Dialog/ButtonWithSubmenu.tsx
@@ -1,6 +1,6 @@
 import clsx from 'clsx';
 import React, { useCallback, useEffect, useMemo, useRef, useState } from 'react';
-import { useDialog, useDialogIsOpen } from './hooks';
+import { useDialogIsOpen, useDialogOnNearestManager } from './hooks';
 import { useDialogAnchor } from './DialogAnchor';
 import type { ComponentProps, ComponentType } from 'react';
 import type { PopperLikePlacement } from './hooks';
@@ -24,8 +24,8 @@ export const ButtonWithSubmenu = ({
   const keepSubmenuOpen = useRef(false);
   const dialogCloseTimeout = useRef<NodeJS.Timeout | null>(null);
   const dialogId = useMemo(() => `submenu-${Math.random().toString(36).slice(2)}`, []);
-  const dialog = useDialog({ id: dialogId });
-  const dialogIsOpen = useDialogIsOpen(dialogId);
+  const { dialog, dialogManager } = useDialogOnNearestManager({ id: dialogId });
+  const dialogIsOpen = useDialogIsOpen(dialogId, dialogManager?.id);
   const { setPopperElement, styles } = useDialogAnchor<HTMLDivElement>({
     open: dialogIsOpen,
     placement,
diff --git a/src/components/Dialog/DialogAnchor.tsx b/src/components/Dialog/DialogAnchor.tsx
@@ -60,6 +60,7 @@ export function useDialogAnchor<T extends HTMLElement>({
 
 export type DialogAnchorProps = PropsWithChildren<Partial<DialogAnchorOptions>> & {
   id: string;
+  dialogManagerId?: string;
   focus?: boolean;
   trapFocus?: boolean;
 } & ComponentProps<'div'>;
@@ -68,6 +69,7 @@ export const DialogAnchor = ({
   allowFlip = true,
   children,
   className,
+  dialogManagerId,
   focus = true,
   id,
   placement = 'auto',
@@ -76,8 +78,8 @@ export const DialogAnchor = ({
   trapFocus,
   ...restDivProps
 }: DialogAnchorProps) => {
-  const dialog = useDialog({ id });
-  const open = useDialogIsOpen(id);
+  const dialog = useDialog({ dialogManagerId, id });
+  const open = useDialogIsOpen(id, dialogManagerId);
   const { setPopperElement, styles } = useDialogAnchor<HTMLDivElement>({
     allowFlip,
     open,
@@ -105,7 +107,7 @@ export const DialogAnchor = ({
   }
 
   return (
-    <DialogPortalEntry dialogId={id}>
+    <DialogPortalEntry dialogId={id} dialogManagerId={dialogManagerId}>
       <FocusScope autoFocus={focus} contain={trapFocus} restoreFocus>
         <div
           {...restDivProps}
diff --git a/src/components/Dialog/DialogPortal.tsx b/src/components/Dialog/DialogPortal.tsx
@@ -2,20 +2,36 @@ import type { PropsWithChildren } from 'react';
 import React, { useCallback } from 'react';
 import { useDialogIsOpen, useOpenedDialogCount } from './hooks';
 import { Portal } from '../Portal/Portal';
-import { useDialogManager } from '../../context';
+import { useDialogManager, useNearestDialogManagerContext } from '../../context';
 
 export const DialogPortalDestination = () => {
-  const { dialogManager } = useDialogManager();
-  const openedDialogCount = useOpenedDialogCount();
+  const { dialogManager } = useNearestDialogManagerContext() ?? {};
+  const openedDialogCount = useOpenedDialogCount({ dialogManagerId: dialogManager?.id });
+  // const [destinationRoot, setDestinationRoot] = useState<HTMLDivElement | null>(null);
+
+  // todo: allow to configure and then enable
+  // useEffect(() => {
+  //   if (!destinationRoot) return;
+  //   const handleClickOutside = (event: MouseEvent) => {
+  //     if (!destinationRoot?.contains(event.target as Node)) {
+  //       dialogManager?.closeAll();
+  //     }
+  //   };
+  //   document.addEventListener('click', handleClickOutside, { capture: true });
+  //   return () => {
+  //     document.removeEventListener('click', handleClickOutside, { capture: true });
+  //   };
+  // }, [destinationRoot, dialogManager]);
 
   if (!openedDialogCount) return null;
 
   return (
     <div
       className='str-chat__dialog-overlay'
-      data-str-chat__portal-id={dialogManager.id}
+      data-str-chat__portal-id={dialogManager?.id}
       data-testid='str-chat__dialog-overlay'
-      onClick={() => dialogManager.closeAll()}
+      onClick={() => dialogManager?.closeAll()}
+      // ref={setDestinationRoot}
       style={
         {
           '--str-chat__dialog-overlay-height': openedDialogCount > 0 ? '100%' : '0',
@@ -27,14 +43,16 @@ export const DialogPortalDestination = () => {
 
 type DialogPortalEntryProps = {
   dialogId: string;
+  dialogManagerId?: string;
 };
 
 export const DialogPortalEntry = ({
   children,
   dialogId,
+  dialogManagerId,
 }: PropsWithChildren<DialogPortalEntryProps>) => {
-  const { dialogManager } = useDialogManager({ dialogId });
-  const dialogIsOpen = useDialogIsOpen(dialogId, dialogManager.id);
+  const { dialogManager } = useDialogManager({ dialogId, dialogManagerId });
+  const dialogIsOpen = useDialogIsOpen(dialogId, dialogManagerId);
 
   const getPortalDestination = useCallback(
     () => document.querySelector(`div[data-str-chat__portal-id="${dialogManager.id}"]`),
diff --git a/src/components/Dialog/hooks/useDialog.ts b/src/components/Dialog/hooks/useDialog.ts
@@ -1,5 +1,9 @@
 import { useCallback, useEffect } from 'react';
-import { modalDialogManagerId, useDialogManager } from '../../../context';
+import {
+  modalDialogManagerId,
+  useDialogManager,
+  useNearestDialogManagerContext,
+} from '../../../context';
 import { useStateStore } from '../../../store';
 
 import type { DialogManagerState, GetOrCreateDialogParams } from '../DialogManager';
@@ -25,6 +29,16 @@ export const useDialog = ({ dialogManagerId, id }: UseDialogParams) => {
   return dialogManager.getOrCreate({ id });
 };
 
+export const useDialogOnNearestManager = ({ id }: Pick<UseDialogParams, 'id'>) => {
+  const { dialogManager } = useNearestDialogManagerContext() ?? {};
+  const dialog = useDialog({ dialogManagerId: dialogManager?.id, id });
+
+  return {
+    dialog,
+    dialogManager,
+  };
+};
+
 export const modalDialogId = 'modal-dialog' as const;
 
 export const useModalDialog = () =>
diff --git a/src/components/MessageActions/MessageActions.tsx b/src/components/MessageActions/MessageActions.tsx
@@ -4,7 +4,7 @@ import React, { useCallback, useRef } from 'react';
 
 import { MessageActionsBox } from './MessageActionsBox';
 
-import { DialogAnchor, useDialog, useDialogIsOpen } from '../Dialog';
+import { DialogAnchor, useDialogIsOpen, useDialogOnNearestManager } from '../Dialog';
 import { ActionsIcon as DefaultActionsIcon } from '../Message/icons';
 import { isUserMuted, shouldRenderMessageActions } from '../Message/utils';
 
@@ -85,8 +85,8 @@ export const MessageActions = (props: MessageActionsProps) => {
 
   const dialogIdNamespace = threadList ? '-thread-' : '';
   const dialogId = `message-actions${dialogIdNamespace}--${message.id}`;
-  const dialog = useDialog({ id: dialogId });
-  const dialogIsOpen = useDialogIsOpen(dialogId);
+  const { dialog, dialogManager } = useDialogOnNearestManager({ id: dialogId });
+  const dialogIsOpen = useDialogIsOpen(dialogId, dialogManager?.id);
 
   const messageActions = getMessageActions();
 
@@ -108,6 +108,7 @@ export const MessageActions = (props: MessageActionsProps) => {
       toggleOpen={dialog?.toggle}
     >
       <DialogAnchor
+        dialogManagerId={dialogManager?.id}
         id={dialogId}
         placement={isMine ? 'top-end' : 'top-start'}
         referenceElement={actionsBoxButtonRef.current}
diff --git a/src/components/MessageActions/__tests__/MessageActions.test.js b/src/components/MessageActions/__tests__/MessageActions.test.js
@@ -1,6 +1,6 @@
 import React from 'react';
 import '@testing-library/jest-dom';
-import { act, cleanup, fireEvent, render, screen } from '@testing-library/react';
+import { act, cleanup, fireEvent, render, screen, waitFor } from '@testing-library/react';
 
 import { MessageActions } from '../MessageActions';
 import { MessageActionsBox as MessageActionsBoxMock } from '../MessageActionsBox';
@@ -137,14 +137,17 @@ describe('<MessageActions /> component', () => {
   it('should close message actions box on icon click if already opened', async () => {
     renderMessageActions();
     expect(MessageActionsBoxMock).not.toHaveBeenCalled();
+    const dialogOverlay = screen.queryByTestId(dialogOverlayTestId);
+    expect(dialogOverlay).not.toBeInTheDocument();
     await toggleOpenMessageActions();
     expect(MessageActionsBoxMock).toHaveBeenLastCalledWith(
       expect.objectContaining({ open: true }),
       undefined,
     );
     await toggleOpenMessageActions();
-    const dialogOverlay = screen.queryByTestId(dialogOverlayTestId);
-    expect(dialogOverlay).not.toBeInTheDocument();
+    await waitFor(() => {
+      expect(dialogOverlay).not.toBeInTheDocument();
+    });
   });
 
   it('should close message actions box when user clicks overlay if it is already opened', async () => {
diff --git a/src/components/MessageInput/AttachmentSelector.tsx b/src/components/MessageInput/AttachmentSelector.tsx
@@ -2,7 +2,7 @@ import React, { useCallback, useEffect, useRef, useState } from 'react';
 import { UploadIcon as DefaultUploadIcon } from './icons';
 import { useAttachmentManagerState } from './hooks/useAttachmentManagerState';
 import { CHANNEL_CONTAINER_ID } from '../Channel/constants';
-import { DialogAnchor, useDialog, useDialogIsOpen } from '../Dialog';
+import { DialogAnchor, useDialogIsOpen, useDialogOnNearestManager } from '../Dialog';
 import { DialogMenuButton } from '../Dialog/DialogMenu';
 import { Modal as DefaultModal } from '../Modal';
 import { ShareLocationDialog as DefaultLocationDialog } from '../Location';
@@ -208,8 +208,10 @@ export const AttachmentSelector = ({
   const actions = useAttachmentSelectorActionsFiltered(attachmentSelectorActionSet);
 
   const menuDialogId = `attachment-actions-menu${messageComposer.threadId ? '-thread' : ''}`;
-  const menuDialog = useDialog({ id: menuDialogId });
-  const menuDialogIsOpen = useDialogIsOpen(menuDialogId);
+  const { dialog: menuDialog, dialogManager } = useDialogOnNearestManager({
+    id: menuDialogId,
+  });
+  const menuDialogIsOpen = useDialogIsOpen(menuDialogId, dialogManager?.id);
 
   const [modalContentAction, setModalContentActionAction] =
     useState<AttachmentSelectorAction>();
@@ -255,6 +257,7 @@ export const AttachmentSelector = ({
           <AttachmentSelectorMenuInitButtonIcon />
         </button>
         <DialogAnchor
+          dialogManagerId={dialogManager?.id}
           id={menuDialogId}
           placement='top-start'
           referenceElement={menuButtonRef.current}
diff --git a/src/components/Modal/GlobalModal.tsx b/src/components/Modal/GlobalModal.tsx
@@ -6,7 +6,7 @@ import { FocusScope } from '@react-aria/focus';
 
 import { CloseIconRound } from './icons';
 
-import { useTranslationContext } from '../../context';
+import { modalDialogManagerId, useTranslationContext } from '../../context';
 import {
   DialogPortalEntry,
   modalDialogId,
@@ -72,7 +72,7 @@ export const GlobalModal = ({
   if (!open || !isOpen) return null;
 
   return (
-    <DialogPortalEntry dialogId={modalDialogId}>
+    <DialogPortalEntry dialogId={modalDialogId} dialogManagerId={modalDialogManagerId}>
       <div
         className={clsx(
           'str-chat str-chat__modal str-chat-react__modal str-chat__modal--open',
diff --git a/src/components/Reactions/ReactionSelectorWithButton.tsx b/src/components/Reactions/ReactionSelectorWithButton.tsx
@@ -1,7 +1,7 @@
 import type { ElementRef } from 'react';
 import React, { useRef } from 'react';
 import { ReactionSelector as DefaultReactionSelector } from './ReactionSelector';
-import { DialogAnchor, useDialog, useDialogIsOpen } from '../Dialog';
+import { DialogAnchor, useDialogIsOpen, useDialogOnNearestManager } from '../Dialog';
 import {
   useComponentContext,
   useMessageContext,
@@ -29,11 +29,13 @@ export const ReactionSelectorWithButton = ({
   const buttonRef = useRef<ElementRef<'button'>>(null);
   const dialogIdNamespace = threadList ? '-thread-' : '';
   const dialogId = `reaction-selector${dialogIdNamespace}--${message.id}`;
-  const dialog = useDialog({ id: dialogId });
-  const dialogIsOpen = useDialogIsOpen(dialogId);
+  const { dialog, dialogManager } = useDialogOnNearestManager({ id: dialogId });
+  const dialogIsOpen = useDialogIsOpen(dialogId, dialogManager?.id);
+
   return (
     <>
       <DialogAnchor
+        dialogManagerId={dialogManager?.id}
         id={dialogId}
         placement={isMyMessage() ? 'top-end' : 'top-start'}
         referenceElement={buttonRef.current}
diff --git a/src/context/DialogManagerContext.tsx b/src/context/DialogManagerContext.tsx
@@ -188,3 +188,6 @@ export const ModalDialogManagerProvider = ({ children }: PropsWithChildrenOnly)
 
 export const useModalDialogManager = () =>
   useMemo(() => getDialogManager(modalDialogManagerId), []);
+
+export const useNearestDialogManagerContext = () =>
+  useContext(DialogManagerProviderContext);
diff --git a/src/experimental/MessageActions/MessageActions.tsx b/src/experimental/MessageActions/MessageActions.tsx
@@ -4,7 +4,11 @@ import type { PropsWithChildren } from 'react';
 
 import { useChatContext, useMessageContext, useTranslationContext } from '../../context';
 import { ActionsIcon } from '../../components/Message/icons';
-import { DialogAnchor, useDialog, useDialogIsOpen } from '../../components/Dialog';
+import {
+  DialogAnchor,
+  useDialogIsOpen,
+  useDialogOnNearestManager,
+} from '../../components/Dialog';
 import { MessageActionsWrapper } from '../../components/MessageActions/MessageActions';
 import { useBaseMessageActionSetFilter, useSplitMessageActionSet } from './hooks';
 import { defaultMessageActionSet } from './defaults';
@@ -48,9 +52,12 @@ export const MessageActions = ({
 
   const dropdownDialogId = `message-actions--${message.id}`;
   const reactionSelectorDialogId = `reaction-selector--${message.id}`;
-  const dialog = useDialog({ id: dropdownDialogId });
-  const dropdownDialogIsOpen = useDialogIsOpen(dropdownDialogId);
-  const reactionSelectorDialogIsOpen = useDialogIsOpen(reactionSelectorDialogId);
+  const { dialog, dialogManager } = useDialogOnNearestManager({ id: dropdownDialogId });
+  const dropdownDialogIsOpen = useDialogIsOpen(dropdownDialogId, dialogManager?.id);
+  const reactionSelectorDialogIsOpen = useDialogIsOpen(
+    reactionSelectorDialogId,
+    dialogManager?.id,
+  );
 
   // do not render anything if total action count is zero
   if (dropdownActionSet.length + quickActionSet.length === 0) {
@@ -78,6 +85,7 @@ export const MessageActions = ({
           </button>
 
           <DialogAnchor
+            dialogManagerId={dialogManager?.id}
             id={dropdownDialogId}
             placement={isMyMessage() ? 'top-end' : 'top-start'}
             referenceElement={actionsBoxButtonElement}
