Storybook

Storybook is a development environment for UI components. It allows you to browse a component library, view the different states of each component, and interactively develop and test components.

This guide will briefly walk you through using Storybook within an Nx workspace.

Setting Up Storybook

Add the Storybook plugin

yarn add --dev @nrwl/storybook

Using Storybook

Generating Storybook Configuration

You can generate Storybook configuration for an individual project with this command:

nx g @nrwl/react:storybook-configuration project-name

Running Storybook

Serve Storybook using this command:

nx run project-name:storybook

Anatomy of the Storybook setup

When running the Nx Storybook generator, it'll configure the Nx workspace to be able to run Storybook seamlessly. It'll create

a global Storybook configuration
a project specific Storybook configuration

The global Storybook configuration allows to set addon-ons or custom webpack configuration at a global level that applies to all Storybook's within the Nx workspace. You can find that folder at .storybook/ at the root of the workspace.

<workspace name>/
├── .storybook/
│   ├── main.js
│   ├── tsconfig.json
├── apps/
├── libs/
├── nx.json
├── package.json
├── README.md
└── etc...

The project-specific Storybook configuration is pretty much similar what you would have for a non-Nx setup of Storybook. There's a .storybook folder within the project root folder.

<project root>/
├── .storybook/
│   ├── main.js
│   ├── preview.js
│   ├── tsconfig.json
├── src/
├── README.md
├── tsconfig.json
└── etc...

Nx React Storybook Preset

@nrwl/react ships with a Storybook preset to make sure it uses the very same configuration as your Nx React application. When you generate a Storybook configuration for a project, it'll automatically add the preset to your configuration.

1const rootMain = require('../../../.storybook/main');
2
3module.exports = {
4  ...rootMain,
5  addons: [...rootMain.addons, '@nrwl/react/plugins/storybook'],
6  ...
7};
8

Using Addons

To register a Storybook addon for all storybook instances in your workspace:

In /.storybook/main.js, in the addons array of the module.exports object, add the new addon:

1module.exports = {
2stories: [...],
3...,
4addons: [..., '@storybook/addon-essentials'],
5};
6

If a decorator is required, in each project's <project-path>/.storybook/preview.js, you can export an array called decorators.
```
1import someDecorator from 'some-storybook-addon';
2export const decorators = [someDecorator];
3
```

-- OR --

To register an addon for a single storybook instance, go to that project's .storybook folder:

In main.js, in the addons array of the module.exports object, add the new addon:

1module.exports = {
2stories: [...],
3...,
4addons: [..., '@storybook/addon-essentials'],
5};
6

If a decorator is required, in preview.js you can export an array called decorators.

1import someDecorator from 'some-storybook-addon';
2export const decorators = [someDecorator];
3

Auto-generate Stories

The @nrwl/react:storybook-configuration generator has the option to automatically generate *.stories.ts files for each component declared in the library.

<some-folder>/
├── my.component.ts
└── my.component.stories.ts

You can re-run it at a later point using the following command:

nx g @nrwl/react:stories <project-name>

Cypress tests for Stories

Both storybook-configuration generator gives the option to set up an e2e Cypress app that is configured to run against the project's Storybook instance.

To launch Storybook and run the Cypress tests against the iframe inside of Storybook:

nx run project-name-e2e:e2e

The url that Cypress points to should look like this:

'/iframe.html?id=buttoncomponent--primary&args=text:Click+me!;padding;style:default'

buttoncomponent is a lowercase version of the Title in the *.stories.ts file.
primary is the name of an individual story.
style=default sets the style arg to a value of default.

Changing args in the url query parameters allows your Cypress tests to test different configurations of your component. You can read the documentation for more information.

Example Files

*.stories.tsx file

1import { Story, Meta } from '@storybook/react';
2import { Button, ButtonProps } from './button';
3
4export default {
5  component: Button,
6  title: 'Button',
7} as Meta;
8
9const Template: Story<ButtonProps> = (args) => <Button {...args} />;
10
11export const Primary = Template.bind({});
12Primary.args = {
13  text: 'Click me!',
14  padding: 0,
15  style: 'default',
16};
17

Cypress test file

Depending on your Cypress version, the file will end with .spec.ts or .cy.ts

1describe('shared-ui', () => {
2  beforeEach(() =>
3    cy.visit(
4      '/iframe.html?id=buttoncomponent--primary&args=text:Click+me!;padding;style:default'
5    )
6  );
7
8  it('should render the component', () => {
9    cy.get('storybook-trial-button').should('exist');
10  });
11});
12