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.

Sign up for GitHub

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

Jump to bottom

fix(@react-aria/overlays): prevent exception on Cypress #2341

Merged
merged 7 commits into from Oct 28, 2021
Merged

fix(@react-aria/overlays): prevent exception on Cypress #2341

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
8be7d91
fix(@react-aria/overlays): prevent exception on Cypress
alirezamirian Sep 16, 2021
a7abbdb
Merge branch 'main' into 2340-overlays-cypress-issue
snowystinger Sep 27, 2021
c5f5266
test(@react-aria/overlays): add two test case for close on scroll
alirezamirian Sep 27, 2021
6e8d812
Merge branch 'main' into 2340-overlays-cypress-issue
snowystinger Oct 27, 2021
c246bed
window scroll to behave same as document
snowystinger Oct 27, 2021
46d5f12
remove comment that no longer applies
snowystinger Oct 27, 2021
e966664
Merge branch 'main' into 2340-overlays-cypress-issue
LFDanLu Oct 28, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 2 additions & 2 deletions packages/@react-aria/overlays/src/useCloseOnScroll.ts
View file
Open in desktop
Expand Up @@ -36,8 +36,8 @@ export function useCloseOnScroll(opts: CloseOnScrollOptions) {

let onScroll = (e: MouseEvent) => {
// Ignore if scrolling an scrollable region outside the trigger's tree.
let target = e.target as HTMLElement;
if (!triggerRef.current || !target.contains(triggerRef.current)) {
let target = e.target;
if (!triggerRef.current || !(target instanceof Node) || !target.contains(triggerRef.current)) {
return;
}

Expand Down
19 changes: 19 additions & 0 deletions packages/@react-aria/overlays/test/useOverlayPosition.test.js
View file
Open in desktop
Expand Up @@ -163,6 +163,25 @@ describe('useOverlayPosition', function () {
fireEvent.scroll(document.body);
expect(onClose).toHaveBeenCalledTimes(1);
});

it('should close the overlay when the document scrolls', function () {
let onClose = jest.fn();
render(<Example isOpen onClose={onClose} />);

fireEvent.scroll(document);
expect(onClose).toHaveBeenCalledTimes(1);
});

it('should not throw or close when target is window in a scroll event', function () {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

so we'll want this test to be the same as the document scroll test, still good to have both tests

// Cypress triggers an artificial scroll event in `screenshot` command:
// https://github.com/cypress-io/cypress/blob/develop/packages/driver/src/cy/commands/screenshot.ts#L106
// More info: https://github.com/adobe/react-spectrum/issues/2340
let onClose = jest.fn();
render(<Example isOpen onClose={onClose} />);

fireEvent.scroll(window);
expect(onClose).toHaveBeenCalledTimes(0);
});
});

describe('useOverlayPosition with positioned container', () => {
Expand Down