Skip to content

Commit

Permalink
docs(storybook): overview adjusted for v7 (#16434)
Browse files Browse the repository at this point in the history
  • Loading branch information
mandarini authored Apr 20, 2023
1 parent 752a923 commit d544102
Show file tree
Hide file tree
Showing 2 changed files with 66 additions and 68 deletions.
67 changes: 33 additions & 34 deletions docs/generated/packages/storybook/documents/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ description: This is an overview page for the Storybook plugin in Nx. It explain

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

{% callout type="info" title="Try out Storybook 7" %}
You can set up your workspace to use Storybook 7 with Nx by following the instructions in the [Storybook 7 setup](/packages/storybook/documents/storybook-7-setup) guide.
{% callout type="info" title="Storybook 7 by default" %}
Starting with Nx 16, Storybook 7 is going to be used by default to configure your projects.
{% /callout %}

## Setting Up Storybook
Expand Down Expand Up @@ -42,28 +42,42 @@ You can generate Storybook configuration for an individual project with this com
nx g @nrwl/storybook:configuration project-name
```

You can choose to use Storybook for one of the supported frameworks:
If you are NOT using a framework-specific generator, in the field `storybook7UiFramework` you must choose one of the following Storybook frameworks:

- `@storybook/angular`
- `@storybook/react`
- `@storybook/react-native`
- `@storybook/html`
- `@storybook/web-components`
- `@storybook/vue`
- `@storybook/vue3`
- `@storybook/svelte`
- `@storybook/html-webpack5`
- `@storybook/nextjs`
- `@storybook/preact-webpack5`
- `@storybook/react-webpack5`
- `@storybook/react-vite`
- `@storybook/server-webpack5`
- `@storybook/svelte-webpack5`
- `@storybook/svelte-vite`
- `@storybook/sveltekit`
- `@storybook/vue-webpack5`
- `@storybook/vue-vite`
- `@storybook/vue3-webpack5`
- `@storybook/vue3-vite`
- `@storybook/web-components-webpack5`
- `@storybook/web-components-vite`

Choosing one of these frameworks will have the following effects on your workspace:

1. Nx will install all the required Storybook packages that go with it.

2. Nx will generate a project-level `.storybook` folder (located under `libs/your-project/.storybook` or `apps/your-project/.storybook`) containing the essential configuration files for Storybook.

3. If you are working on an Angular, a React or a React Native project (and you choose `@storybook/angular`, `@storybook/react` or `@storybook/react-native`) the Nx generator will also generate stories for all the components in your project.
3. Nx will create new `targets` in your project's `project.json`, called `storybook` and `build-storybook`, containing all the necessary configuration to serve and build Storybook.

4. Nx will create new `targets` in your project's `project.json`, called `storybook` and `build-storybook`, containing all the necessary configuration to serve and build Storybook.
4. Nx will generate a new Cypress e2e app for your project (if there isn't one already) to run against the Storybook instance.

5. Nx will generate a new Cypress e2e app for your project (if there isn't one already) to run against the Storybook instance.
Make sure to **use the framework-specific generators** if your project is using Angular, React, Next.js or React Native: [`@nrwl/angular:storybook-configuration`](/packages/angular/generators/storybook-configuration), [`@nrwl/react:storybook-configuration`](/packages/react/generators/storybook-configuration), [`@nrwl/react-native:storybook-configuration`](/packages/react-native/generators/storybook-configuration), for example:

```shell
nx g @nrwl/angular:storybook-configuration my-angular-project --storybook7Configuration
```

These framework-specific generators will also **generate stories** for you.

### Configure your project using TypeScript

Expand Down Expand Up @@ -125,46 +139,30 @@ The project-specific Storybook configuration is pretty much similar what you wou

To register a [Storybook addon](https://storybook.js.org/addons/) for all storybook instances in your workspace:

1. In `/.storybook/main.js`, in the `addons` array of the `module.exports` object, add the new addon:
```typescript {% fileName="/.storybook/main.js" %}
1. In your project's `.storybook/main.js` file, in the `addons` array of the `module.exports` object, add the new addon:

```typescript {% fileName="<project-path>/.storybook/main.js" %}
module.exports = {
stories: [...],
...,
addons: [..., '@storybook/addon-essentials'],
};
```

2. If a decorator is required, in each project's `<project-path>/.storybook/preview.js`, you can export an array called `decorators`.

```typescript {% fileName="<project-path>/.storybook/preview.js" %}
import someDecorator from 'some-storybook-addon';
export const decorators = [someDecorator];
```

**-- OR --**

To register an [addon](https://storybook.js.org/addons/) for a single storybook instance, go to that project's `.storybook` folder:

1. In `main.js`, in the `addons` array of the `module.exports` object, add the new addon:
```typescript
module.exports = {
stories: [...],
...,
addons: [..., '@storybook/addon-essentials'],
};
```
2. If a decorator is required, in `preview.js` you can export an array called `decorators`.

```typescript
import someDecorator from 'some-storybook-addon';
export const decorators = [someDecorator];
```

## More Documentation

You can find dedicated information for React and Angular:

- [Set up Storybook for Angular Projects](/packages/storybook/documents/overview-angular)
- [Set up Storybook for React Projects](/packages/storybook/documents/overview-react)
- [Storybook 7 setup guide](/packages/storybook/documents/storybook-7-setup)

You can find all Storybook-related Nx documentation [here](/packages#storybook).

Expand All @@ -176,3 +174,4 @@ Here's more information on common migration scenarios for Storybook with Nx. For

- [Upgrading to Storybook 6](/packages/storybook/documents/upgrade-storybook-v6-react)
- [Migrate to the Nx React Storybook Addon](/packages/storybook/documents/migrate-webpack-final-react)
- [Storybook 7 migration generator](/packages/storybook/generators/migrate-7)
67 changes: 33 additions & 34 deletions docs/shared/packages/storybook/plugin-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ description: This is an overview page for the Storybook plugin in Nx. It explain

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

{% callout type="info" title="Try out Storybook 7" %}
You can set up your workspace to use Storybook 7 with Nx by following the instructions in the [Storybook 7 setup](/packages/storybook/documents/storybook-7-setup) guide.
{% callout type="info" title="Storybook 7 by default" %}
Starting with Nx 16, Storybook 7 is going to be used by default to configure your projects.
{% /callout %}

## Setting Up Storybook
Expand Down Expand Up @@ -42,28 +42,42 @@ You can generate Storybook configuration for an individual project with this com
nx g @nrwl/storybook:configuration project-name
```

You can choose to use Storybook for one of the supported frameworks:
If you are NOT using a framework-specific generator, in the field `storybook7UiFramework` you must choose one of the following Storybook frameworks:

- `@storybook/angular`
- `@storybook/react`
- `@storybook/react-native`
- `@storybook/html`
- `@storybook/web-components`
- `@storybook/vue`
- `@storybook/vue3`
- `@storybook/svelte`
- `@storybook/html-webpack5`
- `@storybook/nextjs`
- `@storybook/preact-webpack5`
- `@storybook/react-webpack5`
- `@storybook/react-vite`
- `@storybook/server-webpack5`
- `@storybook/svelte-webpack5`
- `@storybook/svelte-vite`
- `@storybook/sveltekit`
- `@storybook/vue-webpack5`
- `@storybook/vue-vite`
- `@storybook/vue3-webpack5`
- `@storybook/vue3-vite`
- `@storybook/web-components-webpack5`
- `@storybook/web-components-vite`

Choosing one of these frameworks will have the following effects on your workspace:

1. Nx will install all the required Storybook packages that go with it.

2. Nx will generate a project-level `.storybook` folder (located under `libs/your-project/.storybook` or `apps/your-project/.storybook`) containing the essential configuration files for Storybook.

3. If you are working on an Angular, a React or a React Native project (and you choose `@storybook/angular`, `@storybook/react` or `@storybook/react-native`) the Nx generator will also generate stories for all the components in your project.
3. Nx will create new `targets` in your project's `project.json`, called `storybook` and `build-storybook`, containing all the necessary configuration to serve and build Storybook.

4. Nx will create new `targets` in your project's `project.json`, called `storybook` and `build-storybook`, containing all the necessary configuration to serve and build Storybook.
4. Nx will generate a new Cypress e2e app for your project (if there isn't one already) to run against the Storybook instance.

5. Nx will generate a new Cypress e2e app for your project (if there isn't one already) to run against the Storybook instance.
Make sure to **use the framework-specific generators** if your project is using Angular, React, Next.js or React Native: [`@nrwl/angular:storybook-configuration`](/packages/angular/generators/storybook-configuration), [`@nrwl/react:storybook-configuration`](/packages/react/generators/storybook-configuration), [`@nrwl/react-native:storybook-configuration`](/packages/react-native/generators/storybook-configuration), for example:

```shell
nx g @nrwl/angular:storybook-configuration my-angular-project --storybook7Configuration
```

These framework-specific generators will also **generate stories** for you.

### Configure your project using TypeScript

Expand Down Expand Up @@ -125,46 +139,30 @@ The project-specific Storybook configuration is pretty much similar what you wou

To register a [Storybook addon](https://storybook.js.org/addons/) for all storybook instances in your workspace:

1. In `/.storybook/main.js`, in the `addons` array of the `module.exports` object, add the new addon:
```typescript {% fileName="/.storybook/main.js" %}
1. In your project's `.storybook/main.js` file, in the `addons` array of the `module.exports` object, add the new addon:

```typescript {% fileName="<project-path>/.storybook/main.js" %}
module.exports = {
stories: [...],
...,
addons: [..., '@storybook/addon-essentials'],
};
```

2. If a decorator is required, in each project's `<project-path>/.storybook/preview.js`, you can export an array called `decorators`.

```typescript {% fileName="<project-path>/.storybook/preview.js" %}
import someDecorator from 'some-storybook-addon';
export const decorators = [someDecorator];
```

**-- OR --**

To register an [addon](https://storybook.js.org/addons/) for a single storybook instance, go to that project's `.storybook` folder:

1. In `main.js`, in the `addons` array of the `module.exports` object, add the new addon:
```typescript
module.exports = {
stories: [...],
...,
addons: [..., '@storybook/addon-essentials'],
};
```
2. If a decorator is required, in `preview.js` you can export an array called `decorators`.

```typescript
import someDecorator from 'some-storybook-addon';
export const decorators = [someDecorator];
```

## More Documentation

You can find dedicated information for React and Angular:

- [Set up Storybook for Angular Projects](/packages/storybook/documents/overview-angular)
- [Set up Storybook for React Projects](/packages/storybook/documents/overview-react)
- [Storybook 7 setup guide](/packages/storybook/documents/storybook-7-setup)

You can find all Storybook-related Nx documentation [here](/packages#storybook).

Expand All @@ -176,3 +174,4 @@ Here's more information on common migration scenarios for Storybook with Nx. For

- [Upgrading to Storybook 6](/packages/storybook/documents/upgrade-storybook-v6-react)
- [Migrate to the Nx React Storybook Addon](/packages/storybook/documents/migrate-webpack-final-react)
- [Storybook 7 migration generator](/packages/storybook/generators/migrate-7)

1 comment on commit d544102

@vercel
Copy link

@vercel vercel bot commented on d544102 Apr 20, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Successfully deployed to the following URLs:

nx-dev – ./

nx-dev-nrwl.vercel.app
nx-dev-git-master-nrwl.vercel.app
nx.dev
nx-five.vercel.app

Please sign in to comment.