Skip to content

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

GDGT-2525 Introduce PortalContainer for Tooltip component (#75103)

Stas Gavrylov58a170bf01ad
diff --git a/.storybook/preview.tsx b/.storybook/preview.tsx
index b0c54fec25c..c248a5e2c24 100644
--- a/.storybook/preview.tsx
+++ b/.storybook/preview.tsx
@@ -1,6 +1,7 @@
import React, { useEffect, useMemo } from "react";
+import { createPortal } from "react-dom";
-import { ThemeProvider } from "metabase/ui";
+import { PortalContainer, ThemeProvider } from "metabase/ui";
// @ts-expect-error: See metabase/utils/delay
// This will skip the skippable delays in stories
@@ -139,6 +140,7 @@ const decorators = [
<ThemeProvider resolvedColorScheme={resolvedColorScheme}>
<Global styles={globalStyles} />
<CssVariables />
+ {createPortal(<PortalContainer />, document.body)}
<Story />
</ThemeProvider>
</EmotionCacheProvider>
diff --git a/frontend/src/metabase/app.js b/frontend/src/metabase/app.js
index 05d49379e6c..0888a88742d 100644
--- a/frontend/src/metabase/app.js
+++ b/frontend/src/metabase/app.js
@@ -25,6 +25,7 @@ import "metabase/utils/csp";
import { createHistory } from "history";
import { DragDropContextProvider } from "react-dnd";
+import { createPortal } from "react-dom";
import { createRoot } from "react-dom/client";
import { useRouterHistory } from "react-router";
import { syncHistoryWithStore } from "react-router-redux";
@@ -42,6 +43,7 @@ import { MetabaseReduxProvider } from "metabase/redux";
import { refreshSiteSettings } from "metabase/redux/settings";
import { getUserId } from "metabase/selectors/user";
import { GlobalStyles } from "metabase/styled-components/containers/GlobalStyles";
+import { PortalContainer } from "metabase/ui";
import { EmotionCacheProvider } from "metabase/ui/components/theme/EmotionCacheProvider";
import { captureConsoleErrors } from "metabase/utils/errors";
import { initTracing, rotateTraceId } from "metabase/utils/otel";
@@ -90,6 +92,7 @@ function _init(reducers, getRoutes, callback) {
<DragDropContextProvider backend={ModifiedBackend} context={{ window }}>
<AppThemeProvider>
<GlobalStyles />
+ {createPortal(<PortalContainer />, document.body)}
<MetabotProvider>
<HistoryProvider history={syncedHistory}>
<RouterProvider>{routes}</RouterProvider>
diff --git a/frontend/src/metabase/ui/components/overlays/PortalContainer/PortalContainer.tsx b/frontend/src/metabase/ui/components/overlays/PortalContainer/PortalContainer.tsx
new file mode 100644
index 00000000000..c7edc906013
--- /dev/null
+++ b/frontend/src/metabase/ui/components/overlays/PortalContainer/PortalContainer.tsx
@@ -0,0 +1,7 @@
+import { Box } from "metabase/ui";
+
+import { PORTAL_CONTAINER_ID } from "./constants";
+
+export const PortalContainer = () => (
+ <Box id={PORTAL_CONTAINER_ID} data-portal="true" display="contents" />
+);
diff --git a/frontend/src/metabase/ui/components/overlays/PortalContainer/PortalContainer.unit.spec.tsx b/frontend/src/metabase/ui/components/overlays/PortalContainer/PortalContainer.unit.spec.tsx
new file mode 100644
index 00000000000..15674cad74e
--- /dev/null
+++ b/frontend/src/metabase/ui/components/overlays/PortalContainer/PortalContainer.unit.spec.tsx
@@ -0,0 +1,28 @@
+import { render, screen } from "__support__/ui";
+import { Tooltip } from "metabase/ui";
+
+import { PORTAL_CONTAINER_ID } from "./";
+
+describe("PortalContainer", () => {
+ it("is mounted as a no-box (display: contents) portal target", () => {
+ render(<div />);
+
+ const container = document.getElementById(PORTAL_CONTAINER_ID);
+ expect(container).toBeInTheDocument();
+ expect(container).toHaveAttribute("data-portal", "true");
+ expect(container).toHaveStyle({ display: "contents" });
+ expect(container).toBeEmptyDOMElement();
+ });
+
+ it("receives tooltip content rendered via the theme's portal target", async () => {
+ render(
+ <Tooltip opened label="portaled tooltip">
+ <button>anchor</button>
+ </Tooltip>,
+ );
+
+ const container = document.getElementById(PORTAL_CONTAINER_ID);
+ const tooltip = await screen.findByText("portaled tooltip");
+ expect(container).toContainElement(tooltip);
+ });
+});
diff --git a/frontend/src/metabase/ui/components/overlays/PortalContainer/constants.ts b/frontend/src/metabase/ui/components/overlays/PortalContainer/constants.ts
new file mode 100644
index 00000000000..c392c85cd32
--- /dev/null
+++ b/frontend/src/metabase/ui/components/overlays/PortalContainer/constants.ts
@@ -0,0 +1 @@
+export const PORTAL_CONTAINER_ID = "metabase-portal-root";
diff --git a/frontend/src/metabase/ui/components/overlays/PortalContainer/index.ts b/frontend/src/metabase/ui/components/overlays/PortalContainer/index.ts
new file mode 100644
index 00000000000..a7a2d75a42f
--- /dev/null
+++ b/frontend/src/metabase/ui/components/overlays/PortalContainer/index.ts
@@ -0,0 +1,2 @@
+export { PortalContainer } from "./PortalContainer";
+export { PORTAL_CONTAINER_ID } from "./constants";
diff --git a/frontend/src/metabase/ui/components/overlays/Tooltip/Tooltip.config.tsx b/frontend/src/metabase/ui/components/overlays/Tooltip/Tooltip.config.tsx
index 36d69188ae8..bef0f865ad7 100644
--- a/frontend/src/metabase/ui/components/overlays/Tooltip/Tooltip.config.tsx
+++ b/frontend/src/metabase/ui/components/overlays/Tooltip/Tooltip.config.tsx
@@ -3,6 +3,8 @@ import cx from "classnames";
import ZIndex from "metabase/css/core/z-index.module.css";
+import { PORTAL_CONTAINER_ID } from "../PortalContainer/constants";
+
import TooltipStyles from "./Tooltip.module.css";
export const tooltipOverrides: MantineThemeOverride["components"] = {
@@ -11,6 +13,9 @@ export const tooltipOverrides: MantineThemeOverride["components"] = {
arrowSize: 10,
withArrow: true,
withinPortal: true,
+ portalProps: {
+ target: `#${PORTAL_CONTAINER_ID}`,
+ },
transitionProps: {
transition: "fade",
duration: 200,
diff --git a/frontend/src/metabase/ui/components/overlays/index.ts b/frontend/src/metabase/ui/components/overlays/index.ts
index 9854a440599..ded8e28bc87 100644
--- a/frontend/src/metabase/ui/components/overlays/index.ts
+++ b/frontend/src/metabase/ui/components/overlays/index.ts
@@ -2,6 +2,7 @@ export * from "./Drawer";
export * from "./HoverCard";
export * from "./Menu";
export * from "./Modal";
+export * from "./PortalContainer";
export * from "./Popover";
export * from "./Overlay";
export * from "./Tooltip";
diff --git a/frontend/test/__support__/ui.tsx b/frontend/test/__support__/ui.tsx
index b0965c9a7b6..3a6315674f9 100644
--- a/frontend/test/__support__/ui.tsx
+++ b/frontend/test/__support__/ui.tsx
@@ -13,6 +13,7 @@ import { createMemoryHistory } from "history";
import { useCallback, useMemo, useState } from "react";
import { DragDropContextProvider } from "react-dnd";
import HTML5Backend from "react-dnd-html5-backend";
+import { createPortal } from "react-dom";
import { Route, useRouterHistory } from "react-router";
import { routerMiddleware, routerReducer } from "react-router-redux";
import _ from "underscore";
@@ -32,7 +33,7 @@ import { createMockState } from "metabase/redux/store/mocks";
import { RouterProvider } from "metabase/router";
import { getMetabaseCssVariables } from "metabase/styled-components/theme/css-variables";
import type { MantineThemeOverride } from "metabase/ui";
-import { ThemeProvider, useMantineTheme } from "metabase/ui";
+import { PortalContainer, ThemeProvider, useMantineTheme } from "metabase/ui";
import { mutateColors } from "metabase/ui/colors/colors";
import { ThemeProviderContext } from "metabase/ui/components/theme/ThemeProvider/context";
import MetabaseSettings from "metabase/utils/settings";
@@ -287,6 +288,7 @@ export function TestWrapper({
onUpdateWhitelabelColors={handleUpdateWhitelabelColors}
>
<GlobalStylesForTest />
+ {createPortal(<PortalContainer />, document.body)}
<MaybeKBar hasKBar={withKBar}>
<MaybeRouter hasRouter={withRouter} history={history}>
@@ -476,7 +478,10 @@ const ThemeProviderWrapper = ({
...props
}: React.PropsWithChildren) => (
<ThemeProviderContext.Provider value={{ withCssVariables: false }}>
- <ThemeProvider {...props}>{children}</ThemeProvider>
+ <ThemeProvider {...props}>
+ {createPortal(<PortalContainer />, document.body)}
+ {children}
+ </ThemeProvider>
</ThemeProviderContext.Provider>
);