React Class autoBind

Automatically binds methods defined within a component's Class to the current object's lexical this instance (similarly to the default behavior of React.createClass).

Description

React 0.13 introduced the possibility to define components using plain JavaScript ES6 classes. But differently from the traditional React.createClass, user defined methods in a ES6 class are not automatically bound.

Autobind is an utility function that can be called from the class constructor to bind the class methods to the component instance.

Installation

To install the stable version:

npm install --save react-autobind

Usage

You will generally call autoBind from the class constructor, passing the 'this' context:

1import autoBind from 'react-autobind';
2
3constructor() {
4  super();
5  autoBind(this);
6}

Autobind is smart enough to avoid binding React related methods (such as render and lifecycle hooks).

You can also explicitly specify which methods you want to bind:

1import autoBind from 'react-autobind';
2
3constructor() {
4  super();
5  autoBind(this, 'myMethod1', 'myMethod2');
6}

Example

1import React from 'react';
2import {render} from 'react-dom';
3import autoBind from 'react-autobind';
4
5class App extends React.Component {
6
7  constructor() {
8    super();
9    this.state = {
10      clickCounter: 0
11    }
12    autoBind(this);
13  }
14
15  componentDidMount() {
16    console.log("Component is mounted");
17  }
18
19  increment() {
20    this.setState({
21      clickCounter: this.state.clickCounter + 1
22    });
23  }
24
25  render(){
26    return (
27      <div>
28        <h1>Number of clicks: {this.state.clickCounter}</h1>
29        <button onClick={this.increment}>Increment Counter</button>
30      </div>
31    );
32  }
33}
34
35render(<App />, document.getElementById('root'));
36