You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 

4.3 KiB

id title permalink layout category
faq-functions Passing Functions to Components docs/faq-functions.html docs FAQ

How do I pass an event handler (like onClick) to a component?

Pass event handlers and other functions as props to child components:

<button onClick={this.handleClick}>

If you need to have access to the parent component in the handler, you also need to bind the function to the component instance (see below).

How do I bind a function to a component instance?

There are several ways to make sure functions have access to component attributes like this.props and this.state, depending on which syntax and build steps you are using.

Bind in Constructor (ES2015)

class Foo extends Component {
  constructor () {
    this.handleClick = this.handleClick.bind(this)
  }
  handleClick() {
    console.log('Click happened')
  }
  render() {
    return <button onClick={this.handleClick}>Click Me</button>
  }
}

Class Properties (Stage 3 Proposal)

class Foo extends Component {
  handleClick = () => {
    console.log('Click happened')
  }
  render() {
    return <button onClick={this.handleClick}>Click Me</button>
  }
}

Bind in Render

class Foo extends Component {
  handleClick () {
    console.log('Click happened')
  }
  render() {
    return <button onClick={this.handleClick.bind(this)}>Click Me</button>
  }
}

Note: Using an arrow function or binding in render creates a new function each time the component renders, which may have performance implications (see below).

Arrow Function in Render

class Foo extends Component {
  handleClick () {
    console.log('Click happened')
  }
  render() {
    return <button onClick={() => this.handleClick()}>Click Me</button>
  }
}

Note: Using an arrow function or binding in render creates a new function each time the component renders, which may have performance implications (see below).

Is it OK to use arrow functions in render methods?

Generally speaking, yes, it is OK, and it is often the easiest way to pass parameters to callback functions.

If you do have performance issues, by all means, optimize!

Why is my function being called every time the component re-renders?

Make sure you aren't calling the function when you pass it to the component:

render() {
  {/* handleClick is called instead of passed as a reference! */}
  return <button onClick={this.handleClick()}>Click Me</button> 
}

How do I pass a parameter to an event handler or callback?

You can use an arrow function to wrap around an event handler and pass parameters:

<Element onClick={() => this.handleClick(id)} />

This is equivalent to calling .bind:

<Element onClick={this.handleClick.bind(this, id)} />

Example: Passing params using arrow functions

const A = 65 // ASCII character code
class Alphabet extends React.Component {
  state = {
      justClicked: null,
      letters: Array.from({length: 26}, (_, i) => String.fromCharCode(A + i))
  }
  
  handleClick = letter => this.setState({ justClicked: letter })
  
  render () {
    return (
      <div>
        Just clicked: {this.state.justClicked}
        <ul>
          { this.state.letters.map(letter => 
            <li key={letter} onClick={() => this.handleClick(letter)}>
              {letter}
            </li>
          ) }
        </ul>
      </div>
   )
  }
}

Example: Passing params using data-attributes

Alternately, you can use DOM APIs to store data needed for event handlers. Consider this approach if you need to optimize a large number of elements or have a render tree that relies on React.PureComponent equality checks.

const A = 65 // ASCII character code
class Alphabet extends React.Component {
  state = {
      justClicked: null,
      letters: Array.from({length: 26}, (_, i) => String.fromCharCode(A + i))
  }
  
  handleClick = event => {
    this.setState({
      justClicked: event.target.dataset.letter
    })
  }
  
  render () {
    return (
      <div>
        Just clicked: {this.state.justClicked}
        <ul>
          { this.state.letters.map(letter => 
            <li key={letter} data-letter={letter} onClick={this.handleClick}>
              {letter}
            </li>
          ) }
        </ul>
      </div>
   )
  }
}