Fix outside click in nested portalled Popover components
#3362
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
This improves the HTML DOM tree if this happens to be used in let's say a `p` tag where `div` elements are not allowed. The `Hidden` element is hidden so it doesn't really matter what the underlying element is. Fixes: #3319
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
RobinMalfait
force-pushed
the
fix/issue-3332
branch
from
6846b33
to
faa0fac
Compare
As a general recap, when an outside click happens, we need to react to
it and typically use the `useOutsideClick` hook.
We also require the context of "allowed root containers", this means
that clicking on a 3rd party toast when a dialog is open, that we allow
this even though we are technically clicking outside of the dialog. This
is simply because we don't have control over these elements.
We also need a reference to know what the "main tree" container is,
because this is the container where your application lives and we _know_
that we are not allowed to click on anything in this container. The
complex part is getting a reference to this element.
```html
<html>
<head>
<title></title>
</head>
<body>
<div id="app"> <-- main root container -->
<div></div>
<div>
<Popover></Popover> <!-- Current component -->
</div>
<div></div>
</div>
<!-- Allowed container #1 -->
<3rd-party-toast-container></3rd-party-toast-container>
</body>
<!-- Allowed container #2 -->
<grammarly-extension></grammarly-extension>
</html>
```
Some examples:
- In case of a `Dialog`, the `Dialog` is rendered in a `Portal` which
means that a DOM ref to the `Dialog` or anything inside will not point
to the "main tree" node.
- In case of a `Popover` we can use the `PopoverButton` as an element
that lives in the main tree. However, if you work with nested
`Popover` components, and the outer `PopoverPanel` uses the `anchor`
or `portal` props, then the inner `PortalButton` will not be in the
main tree either because it will live in the portalled `PopoverPanel`
of the parent.
This is where the `MainTreeProvider` comes in handy. This component will
use the passed in `node` as the main tree node reference and pass this
via the context through the React tree. This means that a nested
`Popover` will still use a reference from the parent `Popover`.
In case of the `Dialog`, we wrap the `Dialog` itself with this provider
which means that the provider will be in the main tree and can be used
inside the portalled `Dialog`.
Another part of the `MainTreeProvider` is that if no node exists in the
parent (reading from context), and no node is provided via props, then
we will briefly render a hidden element, find the root node of the main
tree (aka, the parent element that is a direct child of the body, `body
> *`). Once we found it, we remove the hidden element again. This way we
don't keep unnecessary DOM nodes around.
RobinMalfait
force-pushed
the
fix/issue-3332
branch
from
faa0fac
to
a18abda
Compare
thecrypticace
requested changes
Jul 4, 2024
Co-authored-by: Jordan Pittman <[email protected]>
Co-authored-by: Jordan Pittman <[email protected]>
Co-authored-by: Jordan Pittman <[email protected]>
Co-authored-by: Jordan Pittman <[email protected]>
Co-authored-by: Jordan Pittman <[email protected]>
thecrypticace
approved these changes
Jul 5, 2024
This was referenced Jul 5, 2024
This was referenced Jul 27, 2024
This was referenced Aug 15, 2024
This was referenced Aug 29, 2024
This was referenced Sep 6, 2024
This was referenced Sep 18, 2024
Closed
This was referenced Oct 3, 2024
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 where nested
Popovercomponents that are using theanchorprop (and thus are portalled) are not correctly closed when clicking outside.The issue stems from incorrect DOM node references to know whether we are allowed to click on a certain DOM element or not.
As a general recap, when an outside click happens, we need to react to it and typically use the
useOutsideClickhook for this.We also require the context of "allowed root containers", this means that clicking on a 3rd party toast when a dialog is open, that we allow this even though we are technically clicking outside of the dialog. This is simply because we don't have control over these elements.
We also need a reference to know what the "main tree" container is, because this is the container where your application lives and we know that we are not allowed to click on anything in this container. The complex part is getting a reference to this element.
Some examples:
Dialog, theDialogis rendered in aPortalwhich means that a DOM ref to theDialogor anything inside will not point to the "main tree" node.Popoverwe can use thePopoverButtonas an element that lives in the main tree. However, if you work with nestedPopovercomponents, and the outerPopoverPaneluses theanchororportalprops, then the innerPortalButtonwill not be in the main tree either because it will live in the portalledPopoverPanelof the parent.This is where the
MainTreeProvidercomes in handy. This component will use the passed innodeas the main tree node reference and pass this via the context through the React tree. This means that a nestedPopoverwill still use a reference from the parentPopover.In case of the
Dialog, we wrap theDialogitself with this provider which means that the provider will be in the main tree and can be used inside the portalledDialog.Another part of the
MainTreeProvideris that if no node exists in the parent (reading from context), and no node is provided via props, then we will briefly render a hidden element, find the root node of the main tree (aka, the parent element that is a direct child of the body,body > *). Once we found it, we remove the hidden element again. This way we don't keep unnecessary DOM nodes around.This also fixes another issue #3319, because we will now briefly render the hidden element to determine the main tree node.
Fixes: #3332
Fixes: #3319