{"id":21500495,"url":"https://github.com/node-libraries/storybook-addon-vite-mock","last_synced_at":"2025-07-15T22:31:49.286Z","repository":{"id":234916534,"uuid":"789730313","full_name":"node-libraries/storybook-addon-vite-mock","owner":"node-libraries","description":"Module mock add-on for Storybook(vite)","archived":false,"fork":false,"pushed_at":"2024-10-29T12:21:27.000Z","size":309,"stargazers_count":1,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2024-11-15T03:07:46.768Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/node-libraries.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-04-21T11:59:48.000Z","updated_at":"2024-10-29T12:21:31.000Z","dependencies_parsed_at":"2024-10-29T13:36:54.097Z","dependency_job_id":null,"html_url":"https://github.com/node-libraries/storybook-addon-vite-mock","commit_stats":null,"previous_names":["node-libraries/storybook-addon-vite-mock"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/node-libraries%2Fstorybook-addon-vite-mock","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/node-libraries%2Fstorybook-addon-vite-mock/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/node-libraries%2Fstorybook-addon-vite-mock/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/node-libraries%2Fstorybook-addon-vite-mock/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/node-libraries","download_url":"https://codeload.github.com/node-libraries/storybook-addon-vite-mock/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":226077595,"owners_count":17570163,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-23T17:41:56.941Z","updated_at":"2025-07-15T22:31:49.251Z","avatar_url":"https://github.com/node-libraries.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# storybook-addon-vite-mock\n\n[![](https://img.shields.io/npm/l/storybook-addon-vite-mock)](https://www.npmjs.com/package/storybook-addon-vite-mock)\n[![](https://img.shields.io/npm/v/storybook-addon-vite-mock)](https://www.npmjs.com/package/storybook-addon-vite-mock)\n[![](https://img.shields.io/npm/dw/storybook-addon-vite-mock)](https://www.npmjs.com/package/storybook-addon-vite-mock)\n[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/node-libraries/storybook-addon-vite-mock)\n\nProvides module mocking functionality like `jest.mock` on Storybook@9\n\n![](https://raw.githubusercontent.com/ReactLibraries/storybook-addon-module-mock/master/document/image/image01.png)  \n![](https://raw.githubusercontent.com/ReactLibraries/storybook-addon-module-mock/master/document/image/image02.png)\n\n## usage\n\nAdded 'storybook-addon-vite-mock' to Storybook addons.\nOnly works if Vite is used in the Builder.\n\n### Addon that is confirmed to work\n\n- @storybook/react-vite\n- @storybook/nextjs-vite\n\n### Sample code\n\nhttps://github.com/SoraKumo001/storybook-addon-vite-mock-test\n\n## Addon options\n\nInclude and exclude are enabled for `storybook build` where Babel is used.\nNot used in `storybook dev`.\n\nIf include is omitted, all modules are covered.\n\n```ts\n  addons: [\n    {\n      name: 'storybook-addon-vite-mock',\n      options: {\n        exclude: ({\n          id,\n          // code // Code in build\n        }) =\u003e id.includes(\".stories.\"),\n      },\n    }\n  ],\n```\n\n### Storybook@9 \u0026 @storybook/react-vite\n\n- .storybook/main.ts\n\n```ts\nimport { mergeConfig } from 'vite';\nimport { viteMockPlugin } from 'storybook-addon-vite-mock';\nimport type { StorybookConfig } from '@storybook/react-vite';\n// import type { StorybookConfig } from \"@storybook/nextjs-vite\";\n\nconst config: StorybookConfig = {\n  stories: ['../stories/**/*.mdx', '../stories/**/*.stories.@(js|jsx|mjs|ts|tsx)'],\n  addons: [\n    '@storybook/addon-onboarding',\n    '@storybook/addon-links',\n    '@storybook/addon-essentials',\n    '@chromatic-com/storybook',\n    '@storybook/addon-interactions',\n    'storybook-addon-vite-mock', // Add this line\n  ],\n  framework: {\n    name: '@storybook/react-vite',\n    // name: \"@storybook/nextjs-vite\",\n    options: {},\n  },\n};\nexport default config;\n```\n\n### Sample1\n\n### test.ts\n\n```ts\nexport const Test = () =\u003e 'Test';\n```\n\n#### Button.tsx\n\n```tsx\nimport React from 'react';\nimport PropTypes from 'prop-types';\nimport './button.css';\nimport { Test } from './test';\n\n/**\n * Primary UI component for user interaction\n */\nexport const Button = ({ primary, backgroundColor, size, label, ...props }) =\u003e {\n  const mode = primary ? 'storybook-button--primary' : 'storybook-button--secondary';\n  return (\n    \u003cbutton\n      type=\"button\"\n      className={['storybook-button', `storybook-button--${size}`, mode].join(' ')}\n      style={backgroundColor \u0026\u0026 { backgroundColor }}\n      {...props}\n      onClick={() =\u003e {\n        props.onClick();\n      }}\n    \u003e\n      {label}\n      \u003cdiv\u003e\n        {\n          // insert mock here\n          Test()\n        }\n      \u003c/div\u003e\n    \u003c/button\u003e\n  );\n};\n\nButton.propTypes = {\n  /**\n   * Is this the principal call to action on the page?\n   */\n  primary: PropTypes.bool,\n  /**\n   * What background color to use\n   */\n  backgroundColor: PropTypes.string,\n  /**\n   * How large should the button be?\n   */\n  size: PropTypes.oneOf(['small', 'medium', 'large']),\n  /**\n   * Button contents\n   */\n  label: PropTypes.string.isRequired,\n  /**\n   * Optional click handler\n   */\n  onClick: PropTypes.func,\n};\n\nButton.defaultProps = {\n  backgroundColor: null,\n  primary: false,\n  size: 'medium',\n  onClick: undefined,\n};\n```\n\n#### Button.stories.ts\n\n`createMock` replaces the target module function with the return value of `jest.fn()`.  \nThe `mockRestore()` is automatically performed after the Story display is finished.\n\n```tsx\nimport { fn } from '@storybook/test';\nimport { StoryObj } from '@storybook/react';\nimport { Button } from './Button';\nimport { Test } from './test';\nimport { createMock, getMock, render } from 'storybook-addon-vite-mock';\n\n// More on how to set up stories at: https://storybook.js.org/docs/writing-stories#default-export\nexport default {\n  title: 'Example/Button',\n  component: Button,\n  parameters: {\n    // Optional parameter to center the component in the Canvas. More info: https://storybook.js.org/docs/configure/story-layout\n    layout: 'centered',\n    moduleMock: {\n      mock: () =\u003e {\n        const mock = createMock(Test);\n        return [mock];\n      },\n    },\n  },\n  // This component will have an automatically generated Autodocs entry: https://storybook.js.org/docs/writing-docs/autodocs\n  tags: ['autodocs'],\n  // More on argTypes: https://storybook.js.org/docs/api/argtypes\n  argTypes: {\n    backgroundColor: { control: 'color' },\n  },\n  // Use `fn` to spy on the onClick arg, which will appear in the actions panel once invoked: https://storybook.js.org/docs/essentials/actions#action-args\n  args: {\n    onClick: () =\u003e {\n      fn();\n    },\n  },\n};\n\n// More on writing stories with args: https://storybook.js.org/docs/writing-stories/args\nexport const Primary: StoryObj = {\n  args: {\n    primary: true,\n    label: 'Button',\n  },\n  play: async ({ parameters }) =\u003e {\n    const mock = getMock(parameters, Test);\n    mock.mockReturnValue('Primary');\n    render(parameters);\n  },\n};\n\nexport const Secondary = {\n  args: {\n    label: 'Button',\n  },\n  play: async ({ parameters }) =\u003e {\n    const mock = getMock(parameters, Test);\n    mock.mockReturnValue('Secondary');\n    render(parameters);\n  },\n};\n\nexport const Large = {\n  args: {\n    size: 'large',\n    label: 'Button',\n  },\n  play: async ({ parameters }) =\u003e {\n    const mock = getMock(parameters, Test);\n    mock.mockReturnValue('Large');\n    render(parameters);\n  },\n};\n\nexport const Small = {\n  args: {\n    size: 'small',\n    label: 'Button',\n  },\n  play: async ({ parameters }) =\u003e {\n    const mock = getMock(parameters, Test);\n    mock.mockReturnValue('Small');\n    render(parameters);\n  },\n};\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnode-libraries%2Fstorybook-addon-vite-mock","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnode-libraries%2Fstorybook-addon-vite-mock","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnode-libraries%2Fstorybook-addon-vite-mock/lists"}