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

Feat: Storybook: Improve component organisation - Overlays Category - Issue #66275 #66657

Merged
merged 5 commits into from
Nov 12, 2024

Conversation

hbhalodia
Copy link
Contributor

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

  1. Checkout to the PR.
  2. Run npm run storybook:dev.
  3. Check for the updated components with category that are changed in PR.

Testing Instructions for Keyboard

  • None

Screenshots or screencast

Screenshot 2024-11-01 at 9 17 16 AM Screenshot 2024-11-01 at 9 17 23 AM

@hbhalodia hbhalodia requested a review from ajitbohra as a code owner November 1, 2024 03:47
Copy link

github-actions bot commented Nov 1, 2024

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 props-bot label.

If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message.

Co-authored-by: hbhalodia <[email protected]>
Co-authored-by: tyxla <[email protected]>

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

@hbhalodia hbhalodia requested a review from a team November 1, 2024 03:48
@hbhalodia hbhalodia changed the title Feat: Storybook: Improve component organisation - Overlays Catrgory - Issue #66275 Feat: Storybook: Improve component organisation - Overlays Category - Issue #66275 Nov 1, 2024
Copy link
Member

@tyxla tyxla left a 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',
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Another thing (cc @ciampo @mirka): experimental components will fall in their own section down below, meaning they will have their own Overlays directory. Is that desired? Should we consider marking the experimental components just with badges, like CustomSelectControlV2 is marked WIP?

Copy link
Contributor Author

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.

Copy link
Member

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.

Copy link
Member

@mirka mirka left a 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 🙂

@mirka mirka merged commit 2313836 into WordPress:trunk Nov 12, 2024
62 checks passed
@github-actions github-actions bot added this to the Gutenberg 19.7 milestone Nov 12, 2024
karthick-murugan pushed a commit to karthick-murugan/gutenberg that referenced this pull request Nov 13, 2024
… 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]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Package] Components /packages/components Storybook Storybook and its stories for components [Type] Developer Documentation Documentation for developers
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants