component-kit-builder

builds component kits using webpack require.context


License
ISC
Install
npm install component-kit-builder@3.0.0

Documentation

npm version travis ci status

component-kit-builder

usage

If you structure your components like this:

path/to/component
 +- component.js – basic react component
 +- redux.js – redux component wrapper
 +- relay.js – realy component wrapper

You can use component-kit-builder to build a component kit around your component for easy export and usage of your component wrapper functions.

// any file processed by webpack
import componentKitBuilder from 'component-kit-builder';
const kit = componentKitBuilder(require.context('path/to/component/directory'));

kit now has the following properties:

  • component – component exported form component.js
  • relay – relay wrapper exported from relay.js
  • redux – redux wrapper exported from redux.js
  • relay_wrapped – component wrapped by relay wrapper
  • redux_wrapped – component wrapped by redux wrapper
  • complete – component wrapped by redux and relay

By default, modules whose pre-extension filename are relay and redux are considered wrappers and included in complete and create _wrapped properties on the kit. A custom list of wrappers for component can be defined in the wrappers export in index.js.