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.

Sign up for GitHub

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

Jump to bottom

Feat: Storybook: Improve component organisation - Selection & Input Category - Issue #66275 #66635

Merged
merged 14 commits into from
Nov 13, 2024
Merged

Feat: Storybook: Improve component organisation - Selection & Input Category - Issue #66275 #66635

merged 14 commits into from
Nov 13, 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-10-31 at 4 56 56 PM Screenshot 2024-10-31 at 4 57 10 PM

@github-actions GitHub Actions
Copy link

github-actions bot commented Oct 31, 2024 •
edited
Loading

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 <hbhalodia@git.wordpress.org>
Co-authored-by: mirka <0mirka00@git.wordpress.org>
Co-authored-by: tyxla <tyxla@git.wordpress.org>

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 mirka October 31, 2024 11:29
This was referenced Oct 31, 2024
Closed
Merged
@hbhalodia hbhalodia requested a review from a team October 31, 2024 11:32
@hbhalodia hbhalodia changed the title Feat: Storybook: Improve component organisation - Selection & Input Catrgory - Issue #66275 Feat: Storybook: Improve component organisation - Selection & Input Category - Issue #66275 Nov 1, 2024
tyxla
tyxla reviewed Nov 7, 2024
View reviewed changes
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.

Thank you for working on those @hbhalodia 🙌

I think there are a few things we need to polish before merging. Let me know what you think!

packages/components/src/custom-select-control-v2/stories/index.story.tsx Outdated Show resolved Hide resolved
packages/components/src/custom-gradient-picker/stories/index.story.tsx
@@ -13,7 +13,8 @@ import { useState } from '@wordpress/element';
import CustomGradientPicker from '../';

const meta: Meta< typeof CustomGradientPicker > = {
title: 'Components/CustomGradientPicker',
title: 'Components/Selection & Input/Color/CustomGradientPicker',
Copy link
Member

Choose a reason for hiding this comment

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

This one is displayed under "Deprecated", but it makes sense to be in Color for now because we've technically not deprecated it just yet 👍

packages/components/src/input-control/stories/index.story.tsx Outdated
@@ -16,7 +16,8 @@ import { InputControlSuffixWrapper } from '../input-suffix-wrapper';
import Button from '../../button';

const meta: Meta< typeof InputControl > = {
title: 'Components (Experimental)/InputControl',
title: 'Components (Experimental)/Selection & Input/Common/InputControl',
Copy link
Member

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 Selection & Input > Common directory. Is that desired? Should we consider marking the experimental components just with badges, like CustomSelectControlV2 is marked WIP?

cc @ciampo @mirka

packages/components/src/input-control/stories/index.story.tsx Outdated Show resolved Hide resolved
packages/components/src/number-control/stories/index.story.tsx Outdated
@@ -14,7 +14,8 @@ import { useState } from '@wordpress/element';
import NumberControl from '..';

const meta: Meta< typeof NumberControl > = {
title: 'Components (Experimental)/NumberControl',
title: 'Components (Experimental)/Selection & Input/Common/NumberControl',
Copy link
Member

Choose a reason for hiding this comment

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

Same as above with regards to the separate category.

packages/components/src/number-control/stories/index.story.tsx Outdated Show resolved Hide resolved
packages/components/src/unit-control/stories/index.story.tsx Outdated
@@ -16,7 +16,8 @@ import { CSS_UNITS } from '../utils';

const meta: Meta< typeof UnitControl > = {
component: UnitControl,
title: 'Components (Experimental)/UnitControl',
title: 'Components (Experimental)/Selection & Input/Common/UnitControl',
Copy link
Member

Choose a reason for hiding this comment

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

Same as above with regards to the separate category.

packages/components/src/unit-control/stories/index.story.tsx Outdated Show resolved Hide resolved
storybook/preview.js Outdated Show resolved Hide resolved
@tyxla tyxla added [Type] Developer Documentation Documentation for developers [Package] Components /packages/components Storybook Storybook and its stories for components labels Nov 7, 2024
mirka
mirka approved these changes Nov 13, 2024
View reviewed changes
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.

Thank you for addressing all the feedback!

I went ahead and made a few tweaks, the main ones being:

  • Removed the excessive "Search & Filtering" grouping (ba02698) — This only contains one component, which is generic enough to be included in "Common", and a lot of Common components can also be used for filtering anyway.
  • Removed the unnecessary "Common" grouping from the experimental components (8f01d73) — This is an extra click and doesn't add value right now. We can move them to the normal Common grouping once they graduate to stable.

We can refine as we go, but at this early stage I think we should lean towards simple groupings.

@mirka mirka enabled auto-merge (squash) November 13, 2024 18:44
@mirka mirka merged commit ee5aee9 into WordPress:trunk Nov 13, 2024
61 checks passed
@github-actions github-actions bot added this to the Gutenberg 19.8 milestone Nov 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tyxla tyxla tyxla left review comments

@mirka mirka mirka approved these changes

@ajitbohra ajitbohra Awaiting requested review from ajitbohra ajitbohra is a code owner

@artemiomorales artemiomorales Awaiting requested review from artemiomorales

Assignees

@hbhalodia hbhalodia

Labels
[Package] Components /packages/components Storybook Storybook and its stories for components [Type] Developer Documentation Documentation for developers
Projects
None yet
Milestone
Gutenberg 19.8
Development

Successfully merging this pull request may close these issues.
3 participants
@hbhalodia @mirka @tyxla