Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Menu, Popover, PreviewCard] Set pointer-events: none style on backdrops when hoverable #1351

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 37 additions & 0 deletions packages/react/src/menu/backdrop/MenuBackdrop.test.tsx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import * as React from 'react';
import { Menu } from '@base-ui-components/react/menu';
import { createRenderer, describeConformance } from '#test-utils';
import { screen } from '@mui/internal-test-utils';

describe('<Menu.Backdrop />', () => {
const { render } = createRenderer();
Expand All @@ -11,4 +12,40 @@ describe('<Menu.Backdrop />', () => {
return render(<Menu.Root open>{node}</Menu.Root>);
},
}));

it('sets `pointer-events: none` style on backdrop if opened by hover', async () => {
const { user } = await render(
<Menu.Root delay={0} openOnHover>
<Menu.Trigger>Open</Menu.Trigger>
<Menu.Portal>
<Menu.Backdrop data-testid="backdrop" />
<Menu.Positioner>
<Menu.Popup />
</Menu.Positioner>
</Menu.Portal>
</Menu.Root>,
);

await user.hover(screen.getByText('Open'));

expect(screen.getByTestId('backdrop').style.pointerEvents).to.equal('none');
});

it('does not set `pointer-events: none` style on backdrop if opened by click', async () => {
const { user } = await render(
<Menu.Root delay={0} openOnHover>
<Menu.Trigger>Open</Menu.Trigger>
<Menu.Portal>
<Menu.Backdrop data-testid="backdrop" />
<Menu.Positioner>
<Menu.Popup />
</Menu.Positioner>
</Menu.Portal>
</Menu.Root>,
);

await user.click(screen.getByText('Open'));

expect(screen.getByTestId('backdrop').style.pointerEvents).not.to.equal('none');
});
});
9 changes: 7 additions & 2 deletions packages/react/src/menu/backdrop/MenuBackdrop.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ import { type CustomStyleHookMapping } from '../../utils/getStyleHookProps';
import { popupStateMapping as baseMapping } from '../../utils/popupStateMapping';
import type { TransitionStatus } from '../../utils/useTransitionStatus';
import { transitionStatusMapping } from '../../utils/styleHookMapping';
import { mergeReactProps } from '../../utils/mergeReactProps';

const customStyleHookMapping: CustomStyleHookMapping<MenuBackdrop.State> = {
...baseMapping,
Expand All @@ -25,7 +26,7 @@ const MenuBackdrop = React.forwardRef(function MenuBackdrop(
forwardedRef: React.ForwardedRef<HTMLDivElement>,
) {
const { className, render, ...other } = props;
const { open, mounted, transitionStatus } = useMenuRootContext();
const { open, mounted, transitionStatus, openReason } = useMenuRootContext();

const state: MenuBackdrop.State = React.useMemo(
() => ({
Expand All @@ -40,7 +41,11 @@ const MenuBackdrop = React.forwardRef(function MenuBackdrop(
className,
state,
ref: forwardedRef,
extraProps: { role: 'presentation', hidden: !mounted, ...other },
extraProps: mergeReactProps<'div'>(other, {
role: 'presentation',
hidden: !mounted,
style: openReason === 'hover' ? { pointerEvents: 'none' } : {},
}),
customStyleHookMapping,
});

Expand Down
24 changes: 24 additions & 0 deletions packages/react/src/popover/backdrop/PopoverBackdrop.test.tsx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import * as React from 'react';
import { Popover } from '@base-ui-components/react/popover';
import { createRenderer, describeConformance } from '#test-utils';
import { fireEvent, screen } from '@mui/internal-test-utils';

describe('<Popover.Backdrop />', () => {
const { render } = createRenderer();
Expand All @@ -11,4 +12,27 @@ describe('<Popover.Backdrop />', () => {
return render(<Popover.Root open>{node}</Popover.Root>);
},
}));

it('sets `pointer-events: none` style on backdrop if opened by hover', async () => {
const { user } = await render(
<Popover.Root delay={0} closeDelay={0} openOnHover>
<Popover.Trigger>Open</Popover.Trigger>
<Popover.Portal>
<Popover.Backdrop data-testid="backdrop" />
<Popover.Positioner>
<Popover.Popup />
</Popover.Positioner>
</Popover.Portal>
</Popover.Root>,
);

fireEvent.click(screen.getByText('Open'));

expect(screen.getByTestId('backdrop').style.pointerEvents).not.to.equal('none');

fireEvent.click(screen.getByText('Open'));
await user.hover(screen.getByText('Open'));

expect(screen.getByTestId('backdrop').style.pointerEvents).to.equal('none');
});
});
9 changes: 7 additions & 2 deletions packages/react/src/popover/backdrop/PopoverBackdrop.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ import { type CustomStyleHookMapping } from '../../utils/getStyleHookProps';
import { popupStateMapping as baseMapping } from '../../utils/popupStateMapping';
import type { TransitionStatus } from '../../utils/useTransitionStatus';
import { transitionStatusMapping } from '../../utils/styleHookMapping';
import { mergeReactProps } from '../../utils/mergeReactProps';

const customStyleHookMapping: CustomStyleHookMapping<PopoverBackdrop.State> = {
...baseMapping,
Expand All @@ -26,7 +27,7 @@ const PopoverBackdrop = React.forwardRef(function PopoverBackdrop(
) {
const { className, render, ...other } = props;

const { open, mounted, transitionStatus } = usePopoverRootContext();
const { open, mounted, transitionStatus, openReason } = usePopoverRootContext();

const state: PopoverBackdrop.State = React.useMemo(
() => ({
Expand All @@ -41,7 +42,11 @@ const PopoverBackdrop = React.forwardRef(function PopoverBackdrop(
className,
state,
ref: forwardedRef,
extraProps: { role: 'presentation', hidden: !mounted, ...other },
extraProps: mergeReactProps<'div'>(other, {
role: 'presentation',
hidden: !mounted,
style: openReason === 'hover' ? { pointerEvents: 'none' } : {},
}),
customStyleHookMapping,
});

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import * as React from 'react';
import { PreviewCard } from '@base-ui-components/react/preview-card';
import { screen } from '@mui/internal-test-utils';
import { createRenderer, describeConformance } from '#test-utils';

describe('<PreviewCard.Backdrop />', () => {
Expand All @@ -11,4 +12,22 @@ describe('<PreviewCard.Backdrop />', () => {
return render(<PreviewCard.Root open>{node}</PreviewCard.Root>);
},
}));

it('sets `pointer-events: none` style', async () => {
const { user } = await render(
<PreviewCard.Root delay={0} closeDelay={0}>
<PreviewCard.Trigger>Open</PreviewCard.Trigger>
<PreviewCard.Portal>
<PreviewCard.Backdrop data-testid="backdrop" />
<PreviewCard.Positioner>
<PreviewCard.Popup />
</PreviewCard.Positioner>
</PreviewCard.Portal>
</PreviewCard.Root>,
);

await user.hover(screen.getByText('Open'));

expect(screen.getByTestId('backdrop').style.pointerEvents).to.equal('none');
});
});
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ import { type CustomStyleHookMapping } from '../../utils/getStyleHookProps';
import { popupStateMapping as baseMapping } from '../../utils/popupStateMapping';
import type { TransitionStatus } from '../../utils/useTransitionStatus';
import { transitionStatusMapping } from '../../utils/styleHookMapping';
import { mergeReactProps } from '../../utils/mergeReactProps';

const customStyleHookMapping: CustomStyleHookMapping<PreviewCardBackdrop.State> = {
...baseMapping,
Expand Down Expand Up @@ -41,7 +42,13 @@ const PreviewCardBackdrop = React.forwardRef(function PreviewCardBackdrop(
className,
state,
ref: forwardedRef,
extraProps: { role: 'presentation', hidden: !mounted, ...other },
extraProps: mergeReactProps<'div'>(other, {
role: 'presentation',
hidden: !mounted,
style: {
pointerEvents: 'none',
},
}),
customStyleHookMapping,
});

Expand Down
Loading