Skip to content

The easy-to-use open source Business Intelligence and Embedded Analytics tool that lets everyone work with data :bar_chart:

Restore Escape and backdrop dismissal for dashboard visualization modals (#83663)

Anderson63b18899aa47
diff --git a/frontend/src/metabase/ui/components/overlays/Popover/PopoverDropdown.tsx b/frontend/src/metabase/ui/components/overlays/Popover/PopoverDropdown.tsx
index 6da742b64e1..da6d9bdc27a 100644
--- a/frontend/src/metabase/ui/components/overlays/Popover/PopoverDropdown.tsx
+++ b/frontend/src/metabase/ui/components/overlays/Popover/PopoverDropdown.tsx
@@ -5,7 +5,9 @@ import {
type PopoverStylesNames,
factory,
} from "@mantine/core";
+import { useIsomorphicEffect, useMergedRef } from "@mantine/hooks";
import cx from "classnames";
+import { useState } from "react";
import ZIndex from "metabase/css/core/z-index.module.css";
import { PreventEagerPortal } from "metabase/ui/components/utils/PreventEagerPortal";
@@ -23,15 +25,19 @@ type PopoverDropdownFactory = Factory<{
export const PopoverDropdown = factory<PopoverDropdownFactory>(
function PopoverDropdown({ children, ...props }, ref) {
+ const [element, setElement] = useState<HTMLDivElement | null>(null);
+ const isShown = useIsShown(element);
+ const mergedRef = useMergedRef(ref, setElement);
+
return (
<PreventEagerPortal {...props}>
<MantinePopoverDropdown
{...props}
className={cx(props.className, ZIndex.Overlay)}
data-element-id="mantine-popover"
- ref={ref}
+ ref={mergedRef}
>
- <OverlayStackItem />
+ <OverlayStackItem opened={isShown} />
{children}
</MantinePopoverDropdown>
</PreventEagerPortal>
@@ -40,3 +46,25 @@ export const PopoverDropdown = factory<PopoverDropdownFactory>(
);
PopoverDropdown.classes = MantinePopoverDropdown.classes;
PopoverDropdown.displayName = MantinePopoverDropdown.displayName;
+
+/** Mantine hides kept-mounted dropdowns with an inline `display: none`. */
+function useIsShown(element: HTMLElement | null) {
+ const [isShown, setIsShown] = useState(false);
+
+ useIsomorphicEffect(() => {
+ if (!element) {
+ setIsShown(false);
+ return;
+ }
+
+ const update = () => setIsShown(element.style.display !== "none");
+ update();
+
+ const observer = new MutationObserver(update);
+ observer.observe(element, { attributes: true, attributeFilter: ["style"] });
+
+ return () => observer.disconnect();
+ }, [element]);
+
+ return isShown;
+}
diff --git a/frontend/src/metabase/ui/components/overlays/overlay-stack/overlay-stack.keep-mounted.unit.spec.tsx b/frontend/src/metabase/ui/components/overlays/overlay-stack/overlay-stack.keep-mounted.unit.spec.tsx
new file mode 100644
index 00000000000..93c3d12d7e5
--- /dev/null
+++ b/frontend/src/metabase/ui/components/overlays/overlay-stack/overlay-stack.keep-mounted.unit.spec.tsx
@@ -0,0 +1,89 @@
+import userEvent from "@testing-library/user-event";
+
+import { render, screen, waitFor } from "__support__/ui";
+import { Modal, Select } from "metabase/ui";
+
+function setup({ withinPortal = true } = {}) {
+ const onClose = jest.fn<void, []>();
+
+ render(
+ <Modal.Root opened onClose={onClose}>
+ <Modal.Overlay data-testid="modal-overlay" />
+ <Modal.Content>
+ <Modal.Title>Parent modal</Modal.Title>
+ <Modal.Body>
+ <Select
+ label="Column"
+ data={["Revenue"]}
+ comboboxProps={{ keepMounted: true, withinPortal }}
+ />
+ </Modal.Body>
+ </Modal.Content>
+ </Modal.Root>,
+ );
+
+ return {
+ onClose,
+ input: screen.getByRole("textbox", { name: "Column" }),
+ option: screen.getByText("Revenue"),
+ backdrop: screen.getByTestId("modal-overlay"),
+ };
+}
+
+describe("Modal with a kept-mounted dropdown", () => {
+ it("closes on Escape when the dropdown starts hidden (#83368)", async () => {
+ const { onClose, option } = setup();
+ expect(option).not.toBeVisible();
+
+ await userEvent.keyboard("{Escape}");
+
+ expect(onClose).toHaveBeenCalledTimes(1);
+ });
+
+ it("closes on a backdrop click when the dropdown starts hidden (#83368)", async () => {
+ const { onClose, option, backdrop } = setup({ withinPortal: false });
+ expect(option).not.toBeVisible();
+
+ await userEvent.click(backdrop);
+
+ expect(onClose).toHaveBeenCalledTimes(1);
+ });
+
+ it("dismisses the dropdown before the modal on Escape (#83368)", async () => {
+ const { onClose, input, option } = setup();
+ await userEvent.click(input);
+ expect(option).toBeVisible();
+
+ await userEvent.keyboard("{Escape}");
+
+ await waitFor(() => expect(option).not.toBeVisible());
+ expect(option).toBeInTheDocument();
+ expect(onClose).not.toHaveBeenCalled();
+
+ await userEvent.keyboard("{Escape}");
+
+ expect(onClose).toHaveBeenCalledTimes(1);
+ });
+
+ it("dismisses a reopened dropdown before the modal on backdrop clicks (#83368)", async () => {
+ const { onClose, input, option, backdrop } = setup({ withinPortal: false });
+ await userEvent.click(input);
+ expect(option).toBeVisible();
+ await userEvent.keyboard("{Escape}");
+ await waitFor(() => expect(option).not.toBeVisible());
+ expect(onClose).not.toHaveBeenCalled();
+
+ await userEvent.click(input);
+ expect(option).toBeVisible();
+
+ await userEvent.click(backdrop);
+
+ await waitFor(() => expect(option).not.toBeVisible());
+ expect(option).toBeInTheDocument();
+ expect(onClose).not.toHaveBeenCalled();
+
+ await userEvent.click(backdrop);
+
+ expect(onClose).toHaveBeenCalledTimes(1);
+ });
+});
diff --git a/frontend/src/metabase/ui/components/overlays/overlay-stack/overlay-stack.tsx b/frontend/src/metabase/ui/components/overlays/overlay-stack/overlay-stack.tsx
index d226ced82e0..e51dd2cd234 100644
--- a/frontend/src/metabase/ui/components/overlays/overlay-stack/overlay-stack.tsx
+++ b/frontend/src/metabase/ui/components/overlays/overlay-stack/overlay-stack.tsx
@@ -89,7 +89,7 @@ export const useGatedCloseProps = ({
};
};
-export const OverlayStackItem = () => {
- useIsTopmost(true);
+export const OverlayStackItem = ({ opened }: { opened: boolean }) => {
+ useIsTopmost(opened);
return null;
};