Automatic visual tests in Storybook, plus 2.2x faster build times for React+TSVisual test with Chromatic
Back to integrations
Add your integration
  • ⭐️ Popular
  • 🧩 Essentials
  • 🛠 Code
  • ⚡️ Data & state
  • ✅ Test
  • 💅 Style
  • 🎨 Design
  • ⚙️ Appearance
  • 🗄 Organize
How to install addons Create an addon
Automate, test and debug user interactions
npm install @storybook/addon-interactions
Last updated 8 days ago
Downloads per week
Made by Storybook
Readme View on GitHub

Storybook Addon Interactions

Storybook Addon Interactions enables visual debugging of interactions and tests in Storybook.



Install this addon by adding the @storybook/addon-interactions dependency:

yarn add -D @storybook/addon-interactions @storybook/jest @storybook/testing-library

within .storybook/main.js:

export default {
  addons: ['@storybook/addon-interactions'],

Note that @storybook/addon-interactions must be listed after @storybook/addon-actions or @storybook/addon-essentials.


Interactions relies on "instrumented" versions of Jest and Testing Library, that you import from @storybook/jest and @storybook/testing-library instead of their original package. You can then use these libraries in your play function.

import { Button } from './Button';
import { expect } from '@storybook/jest';
import { within, userEvent } from '@storybook/testing-library';

export default {
  title: 'Button',
  component: Button,
  argTypes: {
    onClick: { action: true },

const Template = (args) => <Button {...args} />;

export const Demo = Template.bind({}); = async ({ args, canvasElement }) => {
  const canvas = within(canvasElement);
  await expect(args.onClick).toHaveBeenCalled();

In order to enable step-through debugging, calls to userEvent.*, fireEvent, findBy*, waitFor* and expect have to be await-ed. While debugging, these functions return a Promise that won't resolve until you continue to the next step.

While you can technically use screen, it's recommended to use within(canvasElement). Besides giving you a better error message when a DOM element can't be found, it will also ensure your play function is compatible with Storybook Docs.

Any args that are marked as an action (typically via argTypes or argTypesRegex) will be automatically wrapped in a Jest mock function so you can assert invocations. See addon-actions for how to setup actions.

Join the community
6,326 developers and counting
WhyWhy StorybookComponent-driven UI
Open source software

Maintained by
Special thanks to Netlify and CircleCI