[tooltip] Fix onOpen/onClose callback not firing due to stale state in React 18 batching#48683
Open
cjz9032 wants to merge 1 commit into
Open
[tooltip] Fix onOpen/onClose callback not firing due to stale state in React 18 batching#48683cjz9032 wants to merge 1 commit into
cjz9032 wants to merge 1 commit into
Conversation
…n React 18 batching
Deploy previewhttps://deploy-preview-48683--material-ui.netlify.app/ Bundle size
Check out the code infra dashboard for more information about this PR. |
Member
|
@cjz9032 Thanks for the PR, would you mind providing a Stackblitz or something that can reproduce/demonstrate the bug? |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Problem
In React 18's automatic batching,
setOpenStatedoes not trigger an immediate re-render. WhenhandleClosechecks theopenvariable right aftersetOpenState, it may read a stale value, causingonCloseto be silently skipped. The same issue affectshandleOpen.This is most noticeable in controlled mode where the
openprop is managed externally: after mouseLeave triggers internal close logic,onClosenever fires, leaving the parent's state out of sync.Fix
Use a
useRefto track the last known open state, synced after each render viauseLayoutEffect. BothhandleOpenandhandleClosecapturewasOpen = openRef.currentbeforeupdating the ref, then usewasOpenfor the callback guard condition instead of the potentially staleopenvariable.Test
Added a test case that verifies
onCloseis called when a controlled tooltip (open={false}) is internally opened via mouseOver withenterDelayand then immediately closed via mouseLeave — without waiting for a re-render between the two events.