Ensure anchored components are properly stacked on top of Dialog components
#3111
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
When you render a `Listbox` in a `Dialog`, then clicking outside of the `Listbox` will only close the `Listbox` and not the `Dialog`. This is because the `Listbox` is rendered _inside_ the `Dialog`, and the `useOutsideClick` hook will prevent the event from propagating to the `Dialog` therefore it stays open. Then, if you add the `anchor` prop to the `ListboxOptions` then a few things will happen: 1. We will render the `ListboxOptions` in a `Modal`, which portals the component to the end of the `body` (aka, it won't be in the `Dialog` anymore). 2. The `anchor` prop, will use Floating UI to position the element correctly. If you now click outside of the open `Listbox`, then the `Dialog` will receive the click event (because it is rendered somewhere else in the DOM) and therefore the `Listbox` **and** the `Dialog` will close. The `Dialog` also uses a `StackProvider` to know if it is the top-level `Dialog` or not. The problem is that the `Modal` doesn't use that `StackProvider` to tell the `Dialog` that something is stacked on top of the current `Dialog`. That's what this commit fixes, the `Modal` will now use a `StackProvider` to tell the `Dialog` that it's not the top-most element anymore so it shouldn't enable the `useOutsideClick` behavior. That said, this is one of the things that will be changed in the future to make "parallel" dialogs possible. Essentially, we will track a global stack and the top-most element (last one that was "opened") will win. Then hooks such as `useOutsideClick` and `useScrollLock` will use that information to know if they should undo scroll locking for example if another element is still open.
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
thecrypticace
approved these changes
Apr 19, 2024
This was referenced May 28, 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.
When you render a
Listboxin aDialog, then clicking outside of theListboxwill only close theListboxand not theDialog.This is because the
Listboxis rendered inside theDialog, and theuseOutsideClickhook will prevent the event from propagating to theDialogtherefore it stays open.Then, if you add the
anchorprop to theListboxOptionsthen a few things will happen:ListboxOptionsin aModal, which portals the component to the end of thebody(aka, it won't be in theDialoganymore).anchorprop, will use Floating UI to position the element correctly.If you now click outside of the open
Listbox, then theDialogwill receive the click event (because it is rendered somewhere else in the DOM) and therefore theListboxand theDialogwill close.The
Dialogalso uses aStackProviderto know if it is the top-levelDialogor not. The problem is that theModaldoesn't use thatStackProviderto tell theDialogthat something is stacked on top of the currentDialog.That's what this commit fixes, the
Modalwill now use aStackProviderto tell theDialogthat it's not the top-most element anymore so it shouldn't enable theuseOutsideClickbehavior.That said, this is one of the things that will be changed in the future to make "parallel" dialogs possible. Essentially, we will track a global stack and the top-most element (last one that was "opened") will win.
Then hooks such as
useOutsideClickanduseScrollLockwill use that information to know if they should undo scroll locking for example if another element is still open.Fixes: #3108