react-web3-hoc v1.0.8

react-web3-hoc

React HOC which injects web3 as soon as it's ready.

Usage

import injectWeb3 from 'react-web3-hoc';

@injectWeb3()
export default class MyComponent extends Component {
  state = {
    coinbase: null
  };

  componentWillMount() {
    // The web3 instance will be available in this.props
    const { web3 } = this.props;
    // We can then do normal web3 api calls
    web3.eth
      .getCoinbase() // Web3 v1.0 syntax
      .then(coinbase => this.setState({ coinbase }))
      .catch(() =>
        this.setState({
          coinbase: `Cannot get coinbase from ${web3.currentProvider.host}`
        })
      );
  }

  render() {
    return <p>Coinbase: {this.state.coinbase}</p>;
  }
}

Or without decorators:

import injectWeb3 from 'react-web3-hoc';

class MyComponent extends Component {
  // ... same code as above
}

export default injectWeb3()(MyComponent);

This HOC will inject the web3 object as soon as it's loaded, and is available in the wrapped component via this.props.web3.

See the example/ folder for a full app using react-web3-hoc.

Install

yarn install react-web3-hoc

API

You can pass in options into injectWeb3.

@injectWeb3(opts)
export default class MyComponent extends Component {
  // ... component code
}

opts is an object with the following fields, all optional.

• fallbackProvider, string (default: null). The HOC will by default use new Web3(window.web3.currentProvider) as web3 instance. If window.web3 is not present, then it will use fallbackProvider via HTTP. If no fallbackProvider has been specified, then web3 will remain undefined.
• loading, React component or function (default: MyComponent, i.e. the inner component). The component to show when web3 is not present or not loaded yet. It will load the inner component by default. A loader component (like a spinner) can be put if you wish to show this loader while web3 is being loaded. Put null here if you wish to show nothing instead.

Contributing

Bugs & Suggestions

Please file an issue if you find a bug while using this library, or if you have any idea on how to improve it.

Hacking locally

git clone https://github.com/amaurymartiny/react-web3-hoc
cd react-web3-hoc
yarn install
yarn build --watch

The built files will live in the build/ folder, and will rebuild whenever you modify a file. The example folder has a symlink injectWeb3.js -> /build/, so you can:

cd example
yarn install
yarn start

And you'll be able to test your code against the example app.

Testing

All code in src/ folder is tested, with a 100% coverage. The test framework is Jest, and React components are unit tested with enzyme.

All code is linted with semistandard style.

License

MIT. See LICENSE file.

Donations

If you like this project, I would really appreciate small donations. Here's my Ethereum address: 0xa395447BF15f7525484C0378c76627D45ADE0B96.