Storybook Addon Apollo Client

Use Apollo Client in your Storybook stories.

Versions

• If you're using Apollo Client 2.x and Storybook 5.x use version 1.x
• If you're using Apollo Client 2.x or 3.x and Storybook 6.x use version 4.x
• If you're using Apollo Client 2.x or 3.x and Storybook 7.x use version 5.x
• If you're using Apollo Client 2.x or 3.x and Storybook 8.x use version 7.x
• If you're using Apollo Client 3.x and Storybook 8.3+ use version 8.x

Known issues

due to how MockedProvider works in Apollo, you will have to hard refresh when visiting sub stories (visiting stories that exist in the same file) to get the expected results, please upvote my comment here to see if we can get this fixed: https://github.com/apollographql/apollo-client/issues/9738#issuecomment-1606316338

Install

pnpm

1pnpm add -D storybook-addon-apollo-client

yarn

1yarn add -D storybook-addon-apollo-client

npm

1npm install -D storybook-addon-apollo-client

Add the addon to your configuration in .storybook/main.ts

1export default {
2  ...config,
3  addons: [
4    ...yourAddons
5    "storybook-addon-apollo-client",
6  ],
7};

7.0 Features

• removed globalMocks key to favor composition

Migrate from 5.x+ to 7.x

Example of < 7.x

preview.ts

1import { MockedProvider } from "@apollo/client/testing"; // Use for Apollo Version 3+
2// import { MockedProvider } from "@apollo/react-testing"; // Use for Apollo Version < 3
3
4export const preview = {
5  parameters: {
6    apolloClient: {
7      MockedProvider,
8      globalMocks: [
9        // whatever mocks you want here
10      ],
11    },
12  },
13};

Example of 7.x

preview.ts

1// Whatever you want here, but not Apollo Client related

component.stories.ts

1import type { Meta } from "@storybook/react";
2import { globalMocks } from "./globalMocks";
3import { otherMocks } from "./otherMocks";
4import { YourComponent, YOUR_QUERY } from "./component";
5
6export const meta: Meta<typeof DisplayLocation> = {
7  component: YourComponent,
8  parameters: {
9    apolloClient: {
10      mocks: [
11        ...globalMocks,
12        ...otherMocks,
13        {
14          request: {
15            query: YOUR_QUERY,
16          },
17          result: {
18            data: {
19              // your data here
20            },
21          },
22        },
23      ],
24    },
25  },
26};

Upgrading from a previous version below 6.x

In previous versions, we had a decorator called withApolloClient this is no longer nesscessary. If you're upgrading from this API here are the following changes that you'll need to make:

1. remove all code referencing the deprecated withApolloClient decorator.
2. follow install instructions

Writing your stories with queries

1import DashboardPage, { DashboardPageQuery } from ".";
2
3export default {
4  title: "My Story",
5};
6
7export const Example = () => <DashboardPage />;
8
9Example.parameters = {
10  apolloClient: {
11    mocks: [
12      {
13        request: {
14          query: DashboardPageQuery,
15        },
16        result: {
17          data: {
18            viewer: null,
19          },
20        },
21      },
22    ],
23  },
24};

Read more about the options available for MockedProvider at https://www.apollographql.com/docs/react/development-testing/testing

Usage

In Storybook, click "Show Addons" and navigate to the "Apollo Client" tab.

Example App

To see real world usage of how to use this addon, check out the example app:

https://github.com/lifeiscontent/realworld

Loading State

You can use the delay parameter to simulate loading state.

1import DashboardPage, { DashboardPageQuery } from ".";
2
3export default {
4  title: "My Story",
5};
6
7export const Example = () => <DashboardPage />;
8
9Example.parameters = {
10  apolloClient: {
11    mocks: [
12      {
13        // Use `delay` parameter to increase loading time
14        delay: 1000,
15        request: {
16          query: DashboardPageQuery,
17        },
18        result: {
19          data: {},
20        },
21      },
22    ],
23  },
24};

Error State

You can use the error parameter to create error state.

1import DashboardPage, { DashboardPageQuery } from ".";
2
3export default {
4  title: "My Story",
5};
6
7export const Example = () => <DashboardPage />;
8
9Example.parameters = {
10  apolloClient: {
11    mocks: [
12      {
13        request: {
14          query: DashboardPageQuery,
15        },
16        error: new ApolloError("This is a mock network error"),
17      },
18    ],
19  },
20};