-
Notifications
You must be signed in to change notification settings - Fork 4.2k
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: Storybook: Improve component organisation - Overlays Category - Issue #66275 #66657
Conversation
The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message.
To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook. |
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.
Thanks for working on this one @hbhalodia! 🙌
It mostly looks good, but there are a few considerations for experimental components we might need to consider before shipping.
@@ -16,7 +16,8 @@ import { ConfirmDialog } from '../component'; | |||
|
|||
const meta: Meta< typeof ConfirmDialog > = { | |||
component: ConfirmDialog, | |||
title: 'Components (Experimental)/ConfirmDialog', | |||
title: 'Components (Experimental)/Overlays/ConfirmDialog', |
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.
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.
experimental components will fall in their own section down below, meaning they will have their own Overlays directory
Waiting on this for confirmation.
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.
I've been discussing this with @ciampo, and we concluded that it's a problem that can be solved separately.
In the future we may remove the "Experimental" distinction from the Storybook component list, and those categories that we're introducing will be on the top level. That being said, we could leave things as they are and ship this PR, and I've opened #66805 to discuss this separately.
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.
🚀
By the way @hbhalodia, now that you are part of the Gutenberg team, you should be able to push branches directly to the repo, and you'll be able to merge PRs yourself once they are approved 🙂
… Issue WordPress#66275 (WordPress#66657) * Group the overlay components in storybook * Fix the id for the experimental components * Remove unwanted changes from the PR Co-authored-by: hbhalodia <[email protected]> Co-authored-by: tyxla <[email protected]> Co-authored-by: mirka <[email protected]>
What?
Why?
This change is part of the larger Storybook Improvements and the shared Sitemap.
How?
Adding Categories that helps organize and group components into sections based on their role and function within the library makes our library easier to navigate and understand.
Testing Instructions
npm run storybook:dev
.Testing Instructions for Keyboard
Screenshots or screencast