Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove deprecated DialogBackdrop and DialogOverlay components #3171

Merged
merged 3 commits into from
May 3, 2024

Conversation

RobinMalfait
Copy link
Member

We deprecated those components in v1.6, since they are no longer documented and this is a major release, we can safely get rid of it.

If you still run into this, you should be able to replace the <DialogOverlay> and <DialogBackdrop> components with a simple <div> instead.

   <Dialog>
-    <DialogOverlay className="..." />
+    <div className="..." />
     <DialogPanel>
       Content
     </DialogPanel>
   </Dialog>

Or

   <Dialog>
-    <DialogBackdrop className="..." />
+    <div className="..." />
     <DialogPanel>
       Content
     </DialogPanel>
   </Dialog>

Copy link

vercel bot commented May 3, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
headlessui-react ✅ Ready (Inspect) Visit Preview 💬 Add feedback May 3, 2024 2:12pm
headlessui-vue ✅ Ready (Inspect) Visit Preview 💬 Add feedback May 3, 2024 2:12pm

We deprecated those components in v1.6, since they are no longer
documented and this is a major release, we can safely get rid of it.
@tchanxx
Copy link

tchanxx commented Jul 5, 2024

Can we also remove DialogBackdrop from the docs if it's removed? https://headlessui.com/react/dialog#dialog-backdrop

@RobinMalfait
Copy link
Member Author

RobinMalfait commented Jul 5, 2024

Hey @tchanxx, we re-introduced it in v2.1.0, which is useful in combination with the new transition prop. See: https://headlessui.com/react/dialog#adding-transitions

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants