storybook-addon-smart-knobs-fork
v5.0.0
Published
Automatically created knobs for storybook.
Downloads
1
Readme
Smart knobs addon for Storybook
This Storybook plugin uses @storybook/addon-knobs
but creates the knobs automatically based on PropTypes and Flow.
Installation:
npm i storybook-addon-smart-knobs --save-dev
Usage:
import React, { PropTypes } from 'react'
import { storiesOf } from '@storybook/react'
import { withKnobs } from '@storybook/addon-knobs'
import { withSmartKnobs } from 'storybook-addon-smart-knobs'
const Button = ({ children, onClick }) => (
<button onClick={ onClick }>{ children }</button>
)
Button.propTypes = {
children: PropTypes.node,
onClick: PropTypes.func
}
storiesOf('Button')
.addDecorator(withSmartKnobs)
.addDecorator(withKnobs)
.add('simple', () => <Button>Smart knobed button</Button>)
Configuration:
This plugin has a peer dependency on babel-plugin-react-docgen
. As a result, babel-plugin-react-docgen
needs to be added to your Storybook Babel configuration.
For a standard Storybook configuration, add react-docgen
to your plugins in an appropriate .babelrc
file.
If you have created a webpack.config.js
file for Storybook, you may need to configure the plugin in there.
module.exports = (baseConfig, env, defaultConfig) => {
defaultConfig.module.rules[0].use[0].options.plugins = [
require.resolve('babel-plugin-react-docgen'),
]
return defaultConfig
}