2020-08-26 20:15:16 +00:00
# Storybook & Components
This repo includes [Storybook ](https://storybook.js.org ) tooling so we can test and develop components in isolation.
2022-09-12 04:29:24 +00:00
The storybook is automatically built and published to [GitHub pages ](https://woocommerce.github.io/woocommerce-blocks/ ) on every push to the main branch.
2020-08-26 20:15:16 +00:00
## Where are our components?
2022-06-09 12:43:17 +00:00
2020-08-26 20:15:16 +00:00
We have components in a few folders, for different contexts.
2022-09-12 04:29:24 +00:00
- [`assets/js/base/components` ](../../assets/js/base/components )
- [`assets/js/editor-components` ](../../assets/js/editor-components )
- [`assets/js/icons` ](../../assets/js/icons )
2020-08-26 20:15:16 +00:00
2022-06-09 12:43:17 +00:00
**`assets/js/base/components`** are used in front-end code, as well as editor & admin.
2020-08-26 20:15:16 +00:00
These components help us build consistent interfaces across the front end (shopper) experience and elsewhere.
Because they can be used in the front end and editor, components in this folder should:
2022-06-09 12:43:17 +00:00
- Perform efficiently - i.e. not adversely affect page performance/experience.
- Have lean dependencies - i.e. not bloat the payload unnecessarily.
- Look consistent in common themes; ideally should allow themes to adjust appearance as necessary.
2020-08-26 20:15:16 +00:00
2022-06-09 12:43:17 +00:00
**`assets/js/editor-components`** are used in the editor UI for our blocks.
2020-08-26 20:15:16 +00:00
They allow us to build a consistent and powerful UI for merchants for authoring content relating to Woo data - e.g. selecting products or product attributes. Because they are focused on the editor, they can rely on known editor dependencies and optimise styling for the editor only.
2022-06-09 12:43:17 +00:00
**`assets/js/icons`** is a suite of icons and SVG images that we use in our interfaces.
2020-08-26 20:15:16 +00:00
2022-09-12 04:29:24 +00:00
For more info about individual components, refer to [Storybook ](https://woocommerce.github.io/woocommerce-blocks/ ) or individual readme files.
2020-08-26 20:15:16 +00:00
## How to run Storybook locally and test components
2022-06-09 12:43:17 +00:00
- `npm run storybook`
- Point your browser at port 6006, e.g. < http: // localhost:6006 >
- Play with components 🎛!
2020-08-26 20:15:16 +00:00
## How to add a story for a component
2022-06-09 12:43:17 +00:00
- Add a `stories` folder alongside the component.
- Add stories in `.js` files in this folder.
2020-08-26 20:15:16 +00:00
If you're stuck, copy source of an existing story to get started.
2022-02-02 14:27:46 +00:00
<!-- FEEDBACK -->
2022-06-09 12:43:17 +00:00
2022-02-02 14:27:46 +00:00
---
2023-12-29 15:28:11 +00:00
[We're hiring! ](https://woo.com/careers/ ) Come work with us!
2022-02-02 14:27:46 +00:00
2023-08-22 09:51:18 +00:00
🐞 Found a mistake, or have a suggestion? [Leave feedback about this document here. ](https://github.com/woocommerce/woocommerce-blocks/issues/new?assignees=&labels=type%3A+documentation&template=--doc-feedback.md&title=Feedback%20on%20./docs/contributors/components.md )
2022-02-02 14:27:46 +00:00
2022-06-09 12:43:17 +00:00
<!-- /FEEDBACK -->
2023-08-22 09:51:18 +00:00
