馃┕ Add stable attribute to toaster container - #741
Open
juanpablob wants to merge 1 commit into
Open
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
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
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.
Fixes #742
First of all, thank you for maintaining such a nice lib :)
What
This PR adds a stable attribute to the
<section>element that wraps the toaster:data-sonner-toaster-container.Why?
Currently, the toaster container itself does not have a stable identifier (like a dedicated data attribute or id). In general, having a clear and explicit way to identify a root container element is helpful for integrations, testing and "interoperability". It avoids relying on DOM structure or implementation details that could change over time.
Further details
Ariakit applies the
inertattribute to all sibling containers when a dialog opens to prevent other elements to be interactive while the dialog is open. To handle certain cases in which one might need to bring other elements in the DOM to be accessible and interactive, they provide a getPersistentElements prop to pass an array of elements that can remain interactive (like Toaster).The issue is that Sonner only adds identifying attributes to the children inside the toaster container, not to the container itself. Ariakit needs a reference to the container element directly, not its children.
I could grab the container by doing
getPersistentElements={() => [document.querySelector('[data-sonner-toaster]').parentElementbut that won't work if no toasts have been triggered by the time the modal opens, since Ariakit expects the element to be in the DOM by the time the dialog opens.The only possible workaround would be:
document.querySelector('[aria-label^="Notifications"]')but this is flaky, let alone that it won't if you're using i18n.How