Skip to main content

Installation

You can get up and running with Badges with a few simple steps:

Install the addon​

  npm i -D storybook-addon-badges

Add to your storybook config​

.storybook/main.ts
// Replace [your-framework] with the framework you are using (e.g., react-webpack5, vue3-vite)
import type { StorybookConfig } from '@storybook/[your-framework]';

const config: StorybookConfig = {
  // ...rest of config
  addons: [
    '@storybook/addon-essentials'
    'storybook-addon-badges', // 👈 register the addon here
  ],
};

export default config;