NOTE: This module is copy of https://github.com/mihalik/react-storybook-addon-docgen. All credits go to the author. I made a new version, since the owner is not updating the project anymore and it didn't work with storybook v3.
React Storybook Docgen Addon
A React Storybook addon to show documentation generated with docgen.
Usage
Install the following module:
yarn add storybook-addon-docgen
Add this line in addons.js
file within your storybook config directory:
;
Then add a decorator to your stories.
;
Have a look at this example stories to see the example usage.
React native storybook
If you are using react native storybook and this addon doesn't work for you, it means that your .babelrc file is missing plugin.
"plugins": [
["react-docgen", { "DOC_GEN_COLLECTION_NAME": "STORYBOOK_REACT_CLASSES"}]
]
Also add global.STORYBOOK_REACT_CLASSES = {};
somewhere in begging of your code
The FAQ
My component name is undefined
or props are not displaying
This addon is using the full information from react-docgen. Look at that project for some examples on documenting components. When creating components, set the displayName
static property to show the correct component name on static builds.