Wondering what’s next for npm?Check out our public roadmap! »

react-proxy-loader

0.1.3 • Public • Published

react-proxy-loader

Wraps a react component in a proxy component to enable Hot Module Replacement and Code Splitting.

installation

npm install react-proxy-loader

Usage

Documentation: Using loaders

var Component = require("react-proxy!./Component");
// => returns the proxied component (You can hot update it.)
 
var Component = require("react-proxy?async!./Component");
// => returns the proxied component (You can hot update it and it loads on demand)
// (webpack creates an additional chunk for this component and its dependencies)
 
var ComponentMixin = require("react-proxy?async!./Component").Mixin;
// => returns a mixin for the proxied component
// (This allows you to setup rendering for the loading state for the proxy)
var Component = React.createClass({
    mixins: [ComponentMixin],
    renderUnavailable: function() {
        return <p>Loading...</p>;
    }
});

The proxy is a react component. All properties are transferred to the wrapped component.

Instead of (or in addition to) inlining the loader call you can also specify the proxied components in your configuration:

module.exports = {
    module: {
        loaders: [
            /* ... */
            {
                test: [
                    /component\.jsx$/, // select component by RegExp
                    /\.async\.jsx$/, // select component by extension
                    "/abs/path/to/component.jsx" // absolute path to component
                ],
                loader: "react-proxy?async"
            }
        ]
    }
};

Advanced: Keeping state between hot updates

Add the react-proxy-loader/KeepStateMixin as mixin to the real component. It's merges the old state (before the update) with the new initial state. This way it's keep the state while hot updating. Note that this only works for the direct child. Nested components doesn't keep their state. You should design your components to be stateless anyway.

License

MIT (http://www.opensource.org/licenses/mit-license.php)

Install

npm i [email protected]

Version

0.1.3

License

MIT

Last publish

Collaborators

  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar