question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Ensure playground stories have working controls

See original GitHub issue

Every component in the storybook sidebar should have a Playground story, those stories should have operable controls.

High level checklist for each component:

  • Move .stories.js file out of next folder, or create .stories.js file and copy contents of *-story.js file over.
  • Remove deprecated knobs package and usage.
  • Ensure there is a playground story
  • Add argtypes to playground story
  • Pass ...args to playground story, spread them on the applicable component(s)
  • Make sure values are defined to enable controls view by default
  • https://github.com/carbon-design-system/carbon/issues/11249

FAQ:

  • What if there’s no playground story but other stories have controls enabled on them?
    • Ignore these components for now, we need to prioritize getting controls working for components that have nothing right now.

Checklist

Issue Analytics

  • State:open
  • Created 2 years ago
  • Comments:6 (6 by maintainers)

github_iconTop GitHub Comments

2reactions
TannerScommented, Sep 27, 2022

Just an fyi @tay1orjones and @tw15egan I am handling

Ensure there is a playground story
Add argtypes to playground story

For TextInput in this pr => https://github.com/carbon-design-system/carbon/pull/12139

I also plan to open a pr to help out with more of these soon

0reactions
aledavilacommented, Oct 4, 2022

@TannerS

  1. We are removing -story.js and replacing it with whats in the next folder. All files in next must move into the root component folder and the next folder deleted.
  2. Default is the main story that shows all of the component props with no controls. Controls only go in playground stories.
  3. see 1
  4. If there are no props that a user can play around with like form then you can omit the playground and do not enable controls.
Read more comments on GitHub >

github_iconTop Results From Across the Web

Update Accordion.stories.js to include a playground ... - GitHub
Checklist Move .stories.js file out of next folder, or create .stories.js file and copy contents ... Ensure playground stories have working controls #10751....
Read more >
Playground Safety (for Parents) - Nemours KidsHealth
Swings, slides, and climbing equipment have different safety concerns. And some kinds of equipment are not safe for playgrounds, no matter how careful...
Read more >
Swift Playground Books - cleanswifter.com
Swift Playground Books are going to usher in creative new ways to learn a programming language, and I can't wait, here's an overview...
Read more >
School Playground Safety Guide | Landscape Structures, Inc.
Find information about school playground safety and state regulations that apply to your location. View our playground safety checklist to learn more.
Read more >
Using Playground Design to Minimize Bullying - Playworld
Cooperative play ensures children get a chance to socialize and to work together, which can help build bridges, even across differences, ...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found