fix: Layer with modal prop does not restrict scroll #6801
Merged
Conversation
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
Bug introduced in v2.30.0
halocline
approved these changes
May 25, 2023
|
Thank you, @CopyJosh. We appreciate the contribution. |
jcfilben
approved these changes
May 25, 2023
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.
Bug introduced in v2.30.0
What does this PR do?
Fixes a bug introduced in v2.30.0 where the Layer would not restrict scroll when passed the modal prop.
Where should the reviewer start?
v2.29.1...v2.30.0
What testing has been done on this PR?
Local testing against our website
How should this be manually tested?
This can be manually tested in storybook, by toggling on "modal" and adjusting the screen width such that
hitResponsiveBreakpointreturns false.This can be manually tested in the docs at https://v2.grommet.io/layer by adding the
modalprop and observing the window still scrolls.Do Jest tests follow these best practices?
screenis used for querying.userEventis used in place offireEvent.asFragment()is used for snapshot testing.Any background context you want to provide?
Up until now the
modalprop alone would appear to restrict the scroll of the page, but maybe that was not a widespread intention given the code comments. If that is the case this PR could be ignored..What are the relevant issues?
#6632
Screenshots (if appropriate)
Do the grommet docs need to be updated?
Should this PR be mentioned in the release notes?
Is this change backwards compatible or is it a breaking change?