Fix Dialog cleanup when the Dialog becomes hidden
#2303
Merged
Conversation
This file contains 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
We have some code that allows us to auto-close the dialog the moment it gets hidden. This is useful if you use a dialog for a mobile menu and you resizet he browser. If you wrap the dialog in a `md:hidden` then it auto closes. If we don't do this, then the dialog is still locking the scrolling, keeping the focus in the dialog, ... but it is not visible. To solve this we use an `IntersectionObserver` to verify that the `boundingClientRect` is "gone" (x = 0, y = 0, width = 0 and height = 0). However, the intersection observer is not always triggered. This happens if the main content is scrollable. Setting the `root` of the `IntersectionObserver` to the parent of the `Dialog` does seem to solve it. Not 100% sure what causes this behaviour exactly.
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR fixes an issue with the
Dialogcomponent where it doesn't properly closes and therefore doesn't properly cleans up the scroll locking, focus trapping, ...We already had the
IntersectionObserverin place for this. But this didn't always trigger properly. For example if theDialogitself didn't have a proper size, but it's content did.We could update the
rootof the intersection observer to a different element but it becomes hard to know which element to use exactly. Just using theparentElementof the Dialog seemed enough, but performing some tests broke other components.Instead, let's use a
ResizeObserver(see browser support: https://developer.mozilla.org/en-US/docs/Web/API/ResizeObserver#browser_compatibility) which gets properly trigger when a Dialog becomes hidden and when it becomes visible again.