Repository navigation
fix: unmount overlays when their exit animation is cancelled #10783
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
Open
pete-woods
wants to merge
1
commit into
adobe:main
Choose a base branch
from
pete-woods:issue-10772
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,87 @@ | ||
| /* | ||
| * Copyright 2026 Adobe. All rights reserved. | ||
| * This file is licensed to you under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. You may obtain a copy | ||
| * of the License at http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software distributed under | ||
| * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS | ||
| * OF ANY KIND, either express or implied. See the License for the specific language | ||
| * governing permissions and limitations under the License. | ||
| */ | ||
|
|
||
| import {act, render} from '@react-spectrum/test-utils-internal'; | ||
| import React, {StrictMode, useRef} from 'react'; | ||
| import {render as renderWithoutWrapper} from '@testing-library/react'; | ||
| import {useEnterAnimation, useExitAnimation} from '../../src/utils/animation'; | ||
|
|
||
| function deferred() { | ||
| let resolve!: () => void; | ||
| let promise = new Promise<void>(r => (resolve = r)); | ||
| return {promise, resolve}; | ||
| } | ||
|
|
||
| describe('animation', () => { | ||
| beforeEach(() => { | ||
| // jsdom skips animations unless getAnimations is implemented. | ||
| Element.prototype.getAnimations = () => []; | ||
| }); | ||
|
|
||
| afterEach(() => { | ||
| // @ts-expect-error | ||
| delete Element.prototype.getAnimations; | ||
| }); | ||
|
|
||
| it('finishes an enter animation that starts on mount in StrictMode', async () => { | ||
| let enter = deferred(); | ||
| let onEnter = jest.fn(() => enter.promise); | ||
| function Test() { | ||
| let ref = useRef<HTMLDivElement>(null); | ||
| let isEntering = useEnterAnimation(ref, true, onEnter); | ||
| return <div ref={ref} data-testid="el" data-entering={isEntering || undefined} />; | ||
| } | ||
|
|
||
| // StrictMode only re-runs effects on mount when it is the root element, which the | ||
| // STRICT_MODE wrapper used by render is not. | ||
| let {getByTestId} = renderWithoutWrapper( | ||
| <StrictMode> | ||
| <Test /> | ||
| </StrictMode> | ||
| ); | ||
| let el = getByTestId('el'); | ||
| expect(onEnter).toHaveBeenCalledTimes(1); | ||
| expect(el).toHaveAttribute('data-entering'); | ||
|
|
||
| await act(async () => enter.resolve()); | ||
| expect(el).not.toHaveAttribute('data-entering'); | ||
| }); | ||
|
|
||
| it('ignores an interrupted exit animation that settles during a later exit', async () => { | ||
| let first = deferred(); | ||
| let second = deferred(); | ||
| let onExit = jest.fn().mockReturnValueOnce(first.promise).mockReturnValueOnce(second.promise); | ||
| function Test({isOpen}: {isOpen: boolean}) { | ||
| let ref = useRef<HTMLDivElement>(null); | ||
| let isExiting = useExitAnimation(ref, isOpen, onExit); | ||
| if (!isOpen && !isExiting) { | ||
| return null; | ||
| } | ||
| return <div ref={ref} data-testid="el" data-exiting={isExiting || undefined} />; | ||
| } | ||
|
|
||
| let {getByTestId, rerender} = render(<Test isOpen />); | ||
| let el = getByTestId('el'); | ||
|
|
||
| rerender(<Test isOpen={false} />); | ||
| rerender(<Test isOpen />); | ||
| rerender(<Test isOpen={false} />); | ||
| expect(onExit).toHaveBeenCalledTimes(2); | ||
|
|
||
| await act(async () => first.resolve()); | ||
| expect(el).toBeInTheDocument(); | ||
| expect(el).toHaveAttribute('data-exiting'); | ||
|
|
||
| await act(async () => second.resolve()); | ||
| expect(el).not.toBeInTheDocument(); | ||
| }); | ||
| }); |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is a bit overly verbose, please trim it
Most of it is probably explained by the tests