fix(toolbar): Fix tooltip & hovercard & menu react-portal rendering i…

…nside the toolbar
getsentry · Jul 23, 2024 · 6bb4638 · 6bb4638
1 parent 55215ce
commit 6bb4638
Show file tree

Hide file tree

Showing 5 changed files with 46 additions and 19 deletions.
diff --git a/static/app/components/devtoolbar/components/providers.tsx b/static/app/components/devtoolbar/components/providers.tsx
@@ -3,6 +3,7 @@ import createCache from '@emotion/cache';
 import {CacheProvider, ThemeProvider} from '@emotion/react';
 import {QueryClient, QueryClientProvider} from '@tanstack/react-query';
 
+import {ReactPortalTargetProvider} from 'sentry/components/react/useReactPortalTarget';
 import {lightTheme} from 'sentry/utils/theme';
 
 import {ConfigurationContextProvider} from '../hooks/useConfiguration';
@@ -33,16 +34,18 @@ export default function Providers({children, config, container}: Props) {
  );
 
  return (
- <CacheProvider value={myCache}>
- <ThemeProvider theme={lightTheme}>
- <ConfigurationContextProvider config={config}>
- <QueryClientProvider client={queryClient}>
- <VisibilityContextProvider>
- <ToolbarRouterContextProvider>{children}</ToolbarRouterContextProvider>
- </VisibilityContextProvider>
- </QueryClientProvider>
- </ConfigurationContextProvider>
- </ThemeProvider>
- </CacheProvider>
+ <ReactPortalTargetProvider target={container}>
+ <CacheProvider value={myCache}>
+ <ThemeProvider theme={lightTheme}>
+ <ConfigurationContextProvider config={config}>
+ <QueryClientProvider client={queryClient}>
+ <VisibilityContextProvider>
+ <ToolbarRouterContextProvider>{children}</ToolbarRouterContextProvider>
+ </VisibilityContextProvider>
+ </QueryClientProvider>
+ </ConfigurationContextProvider>
+ </ThemeProvider>
+ </CacheProvider>
+ </ReactPortalTargetProvider>
  );
 }
diff --git a/static/app/components/dropdownMenu/index.tsx b/static/app/components/dropdownMenu/index.tsx
@@ -7,6 +7,7 @@ import {Item, Section} from '@react-stately/collections';
 
 import type {DropdownButtonProps} from 'sentry/components/dropdownButton';
 import DropdownButton from 'sentry/components/dropdownButton';
+import useReactPortalTarget from 'sentry/components/react/useReactPortalTarget';
 import type {FormSize} from 'sentry/utils/theme';
 import type {UseOverlayProps} from 'sentry/utils/useOverlay';
 import useOverlay from 'sentry/utils/useOverlay';
@@ -153,6 +154,8 @@ function DropdownMenu({
 }: DropdownMenuProps) {
  const isDisabled = disabledProp ?? (!items || items.length === 0);
 
+ const portalTarget = useReactPortalTarget();
+
  const {rootOverlayState} = useContext(DropdownMenuContext);
  const {
  isOpen,
@@ -248,7 +251,7 @@ function DropdownMenu({
  </DropdownMenuList>
  );
 
- return usePortal ? createPortal(menu, document.body) : menu;
+ return usePortal ? createPortal(menu, portalTarget) : menu;
  }
 
  return (

diff --git a/static/app/components/menuListItem.tsx b/static/app/components/menuListItem.tsx
@@ -7,6 +7,7 @@ import styled from '@emotion/styled';
 
 import InteractionStateLayer from 'sentry/components/interactionStateLayer';
 import {Overlay, PositionWrapper} from 'sentry/components/overlay';
+import useReactPortalTarget from 'sentry/components/react/useReactPortalTarget';
 import type {TooltipProps} from 'sentry/components/tooltip';
 import {Tooltip} from 'sentry/components/tooltip';
 import {space} from 'sentry/styles/space';
@@ -247,6 +248,8 @@ function DetailsOverlay({
 
  const popper = usePopper(itemRef.current, overlayElement, POPPER_OPTIONS);
 
+ const portalTarget = useReactPortalTarget();
+
  return createPortal(
  <StyledPositionWrapper
  {...popper.attributes.popper}
@@ -261,7 +264,7 @@ function DetailsOverlay({
  // Safari will clip the overlay if it is inside a scrollable container, even though it is positioned fixed.
  // See https://bugs.webkit.org/show_bug.cgi?id=160953
  // To work around this, we append the overlay to the body
- document.body
+ portalTarget
  );
 }
 

diff --git a/static/app/components/react/useReactPortalTarget.tsx b/static/app/components/react/useReactPortalTarget.tsx
@@ -0,0 +1,18 @@
+import {createContext, type ReactNode, useContext} from 'react';
+
+const ReactPortalTarget = createContext<HTMLElement | ShadowRoot>(document.body);
+
+interface Props {
+ children: ReactNode;
+ target: HTMLElement | ShadowRoot;
+}
+
+export function ReactPortalTargetProvider({children, target}: Props) {
+ return (
+ <ReactPortalTarget.Provider value={target}>{children}</ReactPortalTarget.Provider>
+ );
+}
+
+export default function useReactPortalTarget() {
+ return useContext(ReactPortalTarget);
+}
diff --git a/static/app/components/tooltip.tsx b/static/app/components/tooltip.tsx
@@ -6,11 +6,12 @@ import styled from '@emotion/styled';
 import {AnimatePresence} from 'framer-motion';
 
 import {Overlay, PositionWrapper} from 'sentry/components/overlay';
+import useReactPortalTarget from 'sentry/components/react/useReactPortalTarget';
 import {space} from 'sentry/styles/space';
 import type {UseHoverOverlayProps} from 'sentry/utils/useHoverOverlay';
 import {useHoverOverlay} from 'sentry/utils/useHoverOverlay';
 
-interface TooltipProps extends UseHoverOverlayProps {
+export interface TooltipProps extends UseHoverOverlayProps {
  /**
  * The content to show in the tooltip popover
  */
@@ -26,7 +27,7 @@ interface TooltipProps extends UseHoverOverlayProps {
  overlayStyle?: React.CSSProperties | SerializedStyles;
 }
 
-function Tooltip({
+export function Tooltip({
  children,
  overlayStyle,
  title,
@@ -44,6 +45,8 @@ function Tooltip({
  }
  }, [reset, disabled]);
 
+ const portalTarget = useReactPortalTarget();
+
  if (disabled || !title) {
  return <Fragment>{children}</Fragment>;
  }
@@ -65,7 +68,7 @@ function Tooltip({
  return (
  <Fragment>
  {wrapTrigger(children)}
- {createPortal(<AnimatePresence>{tooltipContent}</AnimatePresence>, document.body)}
+ {createPortal(<AnimatePresence>{tooltipContent}</AnimatePresence>, portalTarget)}
  </Fragment>
  );
 }
@@ -79,6 +82,3 @@ const TooltipContent = styled(Overlay)`
  line-height: 1.2;
  text-align: center;
 `;
-
-export type {TooltipProps};
-export {Tooltip};