-
Notifications
You must be signed in to change notification settings - Fork 81
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
feat: Add Modal deprecation warnings (non-breaking deprecation) #825
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this looks great! do you mind updating the Modal tests to expect this warning? There are some examples of testing the deprecation warning in other components that use it, like NavList
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
awesome, thank you!
the Happo report for the last commit has some weird diffs, like icons/fonts not showing up.. it might be worth trying to re-run to see if they were spurious |
@suzubara Looks like most of those went away after re-running. That's really odd. The legitimate diffs with missing graphics appear to be in Edge. I noticed on the breadcrumb PR that the carets between breadcrumbs were rendering as squares in edge in Happo as well. The accordion diff is weird. It looks like Happo is capturing screenshots while hovering over elements: |
yeah that is weird, I haven't seen that before. I would chalk it up to Happo since the components themselves look fine |
Summary
Adds deprecation warnings to Modal components and functions/hooks in preparation for official removal from this library
Related Issues or PRs
closes #786
(I'm now realizing this issue was still under "Needs Requirements". I figured it'd be some low-hanging-fruit to get a warning out to consumers of this library as early as possible. Whenever we're ready, this branch exists to be merged (or updated then merged) pending any requirement changes)
How To Test
Then preview any Modal story and take note of the console warnings (screenshots below as well)
Screenshots (optional)
Any single export will show a deprecation warning as follows:
Multiple exports will each show specific deprecation warnings