fix(core): menu not scrollable when opening in modal (#8179)

fix AF-1360

When menu (with modal = false) is rendered in Modal, the [RemoveScroll utility wrapped by Modal](https://github.com/radix-ui/primitives/blob/660060a765634e9cc7bf4513f41e8dabc9824d74/packages/react/dialog/src/Dialog.tsx#L203) will prevent menu from scrolling.

The reason why menu is scrollable within a dialog is because it is also wrapped a RemoveScroll [when modal is on. ](https://github.com/radix-ui/primitives/blob/660060a765634e9cc7bf4513f41e8dabc9824d74/packages/react/menu/src/Menu.tsx#L305)

In this fix, added a `useWithinModal` utility hook so that menu will automatically assign noportal mode for menu when it is rendered inside of a modal.
This commit is contained in:
pengx17
2024-09-10 06:09:00 +00:00
parent 9d343bdaa6
commit fb76fdfca3
2 changed files with 70 additions and 81 deletions
@@ -1,5 +1,6 @@
import * as DropdownMenu from '@radix-ui/react-dropdown-menu'; import * as DropdownMenu from '@radix-ui/react-dropdown-menu';
import clsx from 'clsx'; import clsx from 'clsx';
import React from 'react';
import type { MenuProps } from '../menu.types'; import type { MenuProps } from '../menu.types';
import * as styles from '../styles.css'; import * as styles from '../styles.css';
@@ -9,6 +10,7 @@ import * as desktopStyles from './styles.css';
export const DesktopMenu = ({ export const DesktopMenu = ({
children, children,
items, items,
noPortal,
portalOptions, portalOptions,
rootOptions: { rootOptions: {
onOpenChange, onOpenChange,
@@ -33,6 +35,7 @@ export const DesktopMenu = ({
side, side,
sideOffset: (sideOffset ?? 0) + 5, sideOffset: (sideOffset ?? 0) + 5,
}); });
const ContentWrapper = noPortal ? React.Fragment : DropdownMenu.Portal;
return ( return (
<DropdownMenu.Root <DropdownMenu.Root
onOpenChange={handleOpenChange} onOpenChange={handleOpenChange}
@@ -51,7 +54,7 @@ export const DesktopMenu = ({
{children} {children}
</DropdownMenu.Trigger> </DropdownMenu.Trigger>
<DropdownMenu.Portal {...portalOptions}> <ContentWrapper {...portalOptions}>
<DropdownMenu.Content <DropdownMenu.Content
className={clsx( className={clsx(
styles.menuContent, styles.menuContent,
@@ -68,7 +71,7 @@ export const DesktopMenu = ({
> >
{items} {items}
</DropdownMenu.Content> </DropdownMenu.Content>
</DropdownMenu.Portal> </ContentWrapper>
</DropdownMenu.Root> </DropdownMenu.Root>
); );
}; };
@@ -9,7 +9,7 @@ import * as Dialog from '@radix-ui/react-dialog';
import * as VisuallyHidden from '@radix-ui/react-visually-hidden'; import * as VisuallyHidden from '@radix-ui/react-visually-hidden';
import { assignInlineVars } from '@vanilla-extract/dynamic'; import { assignInlineVars } from '@vanilla-extract/dynamic';
import clsx from 'clsx'; import clsx from 'clsx';
import type { CSSProperties, MouseEvent } from 'react'; import type { CSSProperties } from 'react';
import { forwardRef, useCallback, useEffect, useState } from 'react'; import { forwardRef, useCallback, useEffect, useState } from 'react';
import { startScopedViewTransition } from '../../utils'; import { startScopedViewTransition } from '../../utils';
@@ -142,7 +142,6 @@ export const ModalInner = forwardRef<HTMLDivElement, ModalProps>(
overlayOptions: { overlayOptions: {
className: overlayClassName, className: overlayClassName,
style: overlayStyle, style: overlayStyle,
onClick: onOverlayClick,
...otherOverlayOptions ...otherOverlayOptions
} = {}, } = {},
closeButtonOptions, closeButtonOptions,
@@ -191,19 +190,6 @@ export const ModalInner = forwardRef<HTMLDivElement, ModalProps>(
[onEscapeKeyDown, persistent] [onEscapeKeyDown, persistent]
); );
const handleOverlayClick = useCallback(
(e: MouseEvent<HTMLDivElement>) => {
onOverlayClick?.(e);
if (persistent) {
e.preventDefault();
} else {
e.stopPropagation();
onOpenChange?.(false);
}
},
[onOpenChange, onOverlayClick, persistent]
);
if (!container) { if (!container) {
return; return;
} }
@@ -226,9 +212,8 @@ export const ModalInner = forwardRef<HTMLDivElement, ModalProps>(
style={{ style={{
...overlayStyle, ...overlayStyle,
}} }}
onClick={handleOverlayClick}
{...otherOverlayOptions} {...otherOverlayOptions}
/> >
<div <div
data-full-screen={fullScreen} data-full-screen={fullScreen}
data-modal={modal} data-modal={modal}
@@ -294,6 +279,7 @@ export const ModalInner = forwardRef<HTMLDivElement, ModalProps>(
{children} {children}
</Dialog.Content> </Dialog.Content>
</div> </div>
</Dialog.Overlay>
</Dialog.Portal> </Dialog.Portal>
</Dialog.Root> </Dialog.Root>
); );