Skip to content
This repository has been archived by the owner on Feb 23, 2024. It is now read-only.

Improve storybook coverage for general-purpose components #3031

Closed
2 tasks
haszari opened this issue Aug 20, 2020 · 3 comments
Closed
2 tasks

Improve storybook coverage for general-purpose components #3031

haszari opened this issue Aug 20, 2020 · 3 comments
Assignees
Labels
type: enhancement The issue is a request for an enhancement.

Comments

@haszari
Copy link
Member

haszari commented Aug 20, 2020

Adding some storybook coverage for some of our more general-purpose components. As well as improving our storybook coverage, the goal here is to help decide which components might be good candidates for migrating to @woocommerce/components or @wordpress/components.

Component docs/readme, and relationship to other code bases

I also like the idea of using Storybook for more documentation about the components, e.g. when they relate to a Gutenberg component. So might try prototyping that alongside writing stories.

Some examples:

  • The added value in our Button over gutenberg Button. I think our component is a Button with an optional spinner mode, so maybe clearer to name SpinnerButton.
  • Components that are a simple wrapper (of Gutenberg or Reakit) with classes so we can style for our needs. These are unlikely to be worth sharing for reuse.
  • ToggleButtonControl - I recall this being needed as a temporary fix until a Gutenberg button got more support for a toggle state.

Note - Storybook has changed, we may want to upgrade before writing more stories

Storybook 6 has a different api, we're on 5.

See related issue: #3028

PRs / components (feel free to add items, tick box when PR merged)

@haszari haszari added the type: enhancement The issue is a request for an enhancement. label Aug 20, 2020
@haszari haszari self-assigned this Aug 20, 2020
@haszari
Copy link
Member Author

haszari commented Aug 20, 2020

All welcome!

  • Add checkboxes to list for components that need stories.
  • If you start working on one or more stories, add your name to that line.
  • Link the PR when it's up (push a draft PR early!)
  • Check the box when PR is merged ✅

@github-actions
Copy link
Contributor

This issue has been marked as stale because it has not seen any activity within the past 60 days. Remove the stale label or post a comment, otherwise it will be closed in 10 days.

@github-actions github-actions bot added the status: stale Stale issues and PRs have had no updates for 60 days. label Dec 12, 2020
@nerrad
Copy link
Contributor

nerrad commented Dec 15, 2020

I'm going to close this issue because we're not really doing a focused sprint/work on adding stories but rather just including it as continued ongoing work across cooldowns and/or new work.

@nerrad nerrad removed the status: stale Stale issues and PRs have had no updates for 60 days. label Dec 15, 2020
@nerrad nerrad closed this as completed Dec 15, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
type: enhancement The issue is a request for an enhancement.
Projects
None yet
Development

No branches or pull requests

2 participants