To help you visualize the Reference Storefront React UI components, the
react-pwa-reference-storefront project includes an implementation of Storybook. Storybook is a third-party, open-source tool for developing, testing, and displaying UI components in isolation of an application. In general, a story in the Storybook displays a single visual state of a component. With Storybook, you can review the UI components and choose the ones that you want to consume.
Note: Storybook is optional. You can consume the UI components without using Storybook.
The Storybook for the Reference Storefront is located in the
storybook directory. The Storybook includes a story for each component in the
components/src directory. The story is defined in the
.jsx file within the component directory. You can add additional stories for any custom components that you create.
A public instance of Storybook is available to assist with development and consumption of the Reference Storefront React UI components: https://ui-components.elasticpath.com/
yarn to run the
storybook project. In Storybook, each story shows you an image of the selected component.
Go to the
storybookdirectory and run the project.
…/react-pwa-reference-storefront/storybook> yarn storybook
From the sidebar, select a component.
For example, if you select
CartMain, the cart component appears with sample items, data, and default styling.
Creating Storybook stories
If you create custom React UI components, you can add stories for the custom components to Storybook. For more information about writing stories, see Writing stories in the Storybook documentation.
components/srcdirectory, find the custom component.
components/src/<customComponent>directory, create a
<customComponent>.stories.tsxfile, where the file prefix shares the same name as the directory.
For example, if the component directory is
components/src/mycomponent, then the story file must be named
- Update the story with the necessary response structure data from Cortex.
- Add all required components and content for the component.
- Import the component which the story belongs to as required.
Tip: Use an existing
<component>.stories.tsx file as a reference for the content in your