Ensure popovers that open dialogs do not close when the dialog opens #2554
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: aee75bf 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 |
|
siddharthkp
reviewed
Feb 1, 2024
| let node: HTMLElement | null = this.dialog | ||
| while (node) { | ||
| node = node.closest('[popover]:not(:popover-open)') | ||
| if (node) node.showPopover() |
There was a problem hiding this comment.
Ah, I see! This block makes sense to me!
keithamus
force-pushed
the
ensure-popovers-that-open-dialogs-do-not-close-when-the-dialog-opens
branch
from
269e2d3
to
aee75bf
Compare
jonrohan
approved these changes
Feb 1, 2024
camertron
deleted the
ensure-popovers-that-open-dialogs-do-not-close-when-the-dialog-opens
branch
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?
Users of the
Primer::Alpha::Overlay(which uses web nativepopover) component to create custom floating UI may run into an issue when they nest aPrimer::Alpha::Dialog(which uses web native<dialog>) inside of the overlay. This is because at current the algorithm forshowModal()runs the internalhide all popoversalgorithm. This closes the Overlay, but as the Dialog inside is nested, it will be hidden (display:noneeffects all children). This issue is described in whatwg/html#9998 and it is fixed in Chrome 124 (observable in the chromium nightlies). Until all browsers fix it though, we need to work around the issue.One solution for now, is for engineers to not nest dialogs in other floating UI. This is generally a very good idea, however it is also not always completely practical, and so we should cater to engineers with the design system where we can.
Screenshots
Integration
List the issues that this change affects.
Closes # (type the GitHub issue number after #)
Risk Assessment
What approach did you choose and why?
I chose to watch for when our Dialog component opens, to reverse the steps taken by the
hide all popoversalgorithm. This means we will traverse up the tree, looking forpopoverelements that are:popover-open, andAnything you want to highlight for special attention from reviewers?
Accessibility
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.