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

Storybook: Migrate Knobs to Controls #35665

Closed
mirka opened this issue Oct 15, 2021 · 2 comments
Closed

Storybook: Migrate Knobs to Controls #35665

mirka opened this issue Oct 15, 2021 · 2 comments
Labels
[Feature] UI Components Impacts or related to the UI component system Needs Dev Note Requires a developer note for a major WordPress release cycle [Package] Components /packages/components Storybook Storybook and its stories for components [Type] Tracking Issue Tactical breakdown of efforts across the codebase and/or tied to Overview issues.

Comments

@mirka
Copy link
Member

mirka commented Oct 15, 2021

What problem does this address?

New stories should be written using Controls, as this will make things much easier and Knobs are now deprecated.

Because Controls and Knobs are shown in separate panels, to have them both enabled globally is noisy and confusing. It also encourages people to continue using Knobs in new stories.

What is your proposed solution?

It would probably be better if we migrated the existing Knobs usage to Controls, and remove the global Knobs decorator. For the few stories that would be less than straightforward to migrate at this time, we can keep them as is and add the Knobs decorator for those isolated cases.

@mirka mirka added [Feature] UI Components Impacts or related to the UI component system Storybook Storybook and its stories for components labels Oct 15, 2021
@ciampo ciampo added [Type] Tracking Issue Tactical breakdown of efforts across the codebase and/or tied to Overview issues. [Package] Components /packages/components labels Feb 16, 2022
@mirka mirka removed their assignment Aug 19, 2022
@bph bph added the Needs Dev Note Requires a developer note for a major WordPress release cycle label Jan 14, 2023
@bph
Copy link
Contributor

bph commented Jan 14, 2023

Added the "Needs Dev Note" label to put in our our radar for WordPress 6.2 Fieldguide
Three options:

  • stand-alone Dev note post on make blog
  • Mentioned is "Miscellaneous Editor Updates" dev note post
  • Listed under "But Wait there is more" section of the Fieldguide.

At the moment if seems like a stand-along post would be warranted.

@mirka
Copy link
Member Author

mirka commented Jan 23, 2023

Migration complete 🎉 Addon package removed in #47152.

@mirka mirka closed this as completed Jan 23, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Feature] UI Components Impacts or related to the UI component system Needs Dev Note Requires a developer note for a major WordPress release cycle [Package] Components /packages/components Storybook Storybook and its stories for components [Type] Tracking Issue Tactical breakdown of efforts across the codebase and/or tied to Overview issues.
Projects
None yet
Development

No branches or pull requests

3 participants