@takuma-ru/auto-story-generator
@takuma-ru/auto-story-generator
![]()
Description
Automatic real-time story file generation from React, Vue, Angular and Lit component files
Getting Started
1. Install the package
npm i @takuma-ru/auto-story-generator
2. Add config
Add settings to main.ts in Storybook (./storybook/main.ts)
For React, Vite
import type { StorybookConfig } from "@storybook/react-vite";
import autoStoryGenerator from "@takuma-ru/auto-story-generator";
import { mergeConfig } from "vite";
const config: StorybookConfig = {
viteFinal: async config =>
mergeConfig(config, {
plugins: [
autoStoryGenerator.vite({
preset: "react",
imports: ["src/components/**/*.tsx"],
}),
],
}),
};
export default config;
Supported Frameworks
✅: Supported 🚧: Work in progress ❌: Not supported 📝: Not yet implemented
| Framework | Supported |
|---|---|
| React | ✅ |
| Vue | 🚧 |
| Lit | ✅ |
| Angular | 🚧 |
| Svelte | 📝 |
| Custom | 📝 |
Contributors
Main contributor
takuma-ru : Core API, React presets more...
Special thanks
Related Packages
@storybook/addon-onboarding
Storybook Onboarding: Help new users learn how to write stories
139,691,195
91,335
@storybook/addon-vitest
Storybook Vitest addon: Blazing fast component testing using stories
130,125,843
91,335
storybook-router
A storybook decorator that allows you to use routing-aware components in your st...
26,590
257
Version History
| Version | Released | License |
|---|---|---|
| 0.4.0 | ISC | |
| 0.3.3 | ISC | |
| 0.3.2 | ISC | |
| 0.3.1 | ISC | |
| 0.3.0 | ISC | |
| 0.2.11 | ISC | |
| 0.2.10 | ISC | |
| 0.2.9 | ISC | |
| 0.2.8 | ISC | |
| 0.2.7 | ISC | |
| 0.2.6 | ISC | |
| 0.2.5 | ISC | |
| 0.2.4 | ISC | |
| 0.2.3 | ISC | |
| 0.2.2 | ISC | |
| 0.2.1 | ISC | |
| 0.2.0 | ISC | |
| 0.1.1 | ISC | |
| 0.1.0 | ISC |
Pre-releases (6)
| Version | Released | License |
|---|---|---|
| 0.2.10-beta.0 | ISC | |
| 0.0.2-beta.3 | ISC | |
| 0.0.2-beta.2 | MIT | |
| 0.0.2-beta.1 | MIT | |
| 0.0.2-beta.0 | MIT | |
| 0.0.1-beta.0 | MIT |