Fix issue where dialog is unable to be closed #2288
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
🦋 Changeset detectedLatest commit: a108bca The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
github-actions
bot
added
the
javascript
TylerJDev
commented
Oct 17, 2023
Comment on lines
-33
to
-35
| // Find the top level dialog that is open. | ||
| const topLevelDialog = overlayStack[overlayStack.length - 1] | ||
| if (!topLevelDialog) return |
There was a problem hiding this comment.
It did not seem like we needed to rely on checking if the "top level" dialog was open at this point. The function should only be ran the moment a user clicks the close button. This should only target the dialog where that event stemmed, and shouldn't affect any other dialogs that are open.
I removed this logic and replaced it with a conditional that will only check if one of the two acceptable button data-* attributes exist.
keithamus
approved these changes
Oct 17, 2023
Merged
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.
Authors: Please fill out this form carefully and completely.
Reviewers: By approving this Pull Request you are approving the code change, as well as its deployment and mitigation plans.
Please read this description carefully. If you feel there is anything unclear or missing, please ask for updates.
What are you trying to accomplish?
Fixes bug where dialog is unable to be closed if another dialog is opened at the time.
Screenshots
Integration
List the issues that this change affects.
https://github.com/github/primer/issues/2748
Risk Assessment
What approach did you choose and why?
We currently store active dialogs in an array named
overlayStack. When clicking the close button, we check if the button is within the dialog that was most recently opened. If it is not, then you are unable to close the dialog through clicking the button.This PR aims to fix that issue by removing the
topLevelDialogdependency.Anything you want to highlight for special attention from reviewers?
Merge checklist
Take a look at the What we look for in reviews section of the contributing guidelines for more information on how we review PRs.