bindActionCreators(actionCreators, dispatch)

概要

値がアクションクリエーターであるオブジェクトを、同じキーを持つオブジェクトに変換します。ただし、各アクションクリエーターはdispatch呼び出しでラップされているため、直接呼び出すことができます。

通常は、dispatchをStoreインスタンスで直接呼び出す必要があります。ReactでReduxを使用する場合、react-reduxはdispatch関数を提供するため、直接呼び出すこともできます。

bindActionCreatorsを使用する唯一のケースは、Reduxを認識していないコンポーネントにアクションクリエーターを渡したい場合、そしてdispatchまたはReduxストアを渡したくない場合です。

便宜上、アクションクリエーターを最初の引数として渡し、dispatchでラップされた関数を返すこともできます。

警告

これはもともと、レガシーなReact-Reduxのconnectメソッドで使用することを目的としていました。今でも機能しますが、めったに必要なものではありません。

パラメーター

1. actionCreators (関数またはオブジェクト): アクションクリエーター、または値がアクションクリエーターであるオブジェクト。

2. dispatch (関数): Storeインスタンスで使用可能なdispatch関数。

戻り値

(関数またはオブジェクト): 元のオブジェクトを模倣したオブジェクトですが、各関数は対応するアクションクリエーターによって返されたアクションを即座にディスパッチします。actionCreatorsとして関数を渡した場合、戻り値も単一の関数になります。

例

TodoActionCreators.js

export function addTodo(text) {
  return {
    type: 'ADD_TODO',
    text
  }
}

export function removeTodo(id) {
  return {
    type: 'REMOVE_TODO',
    id
  }
}

SomeComponent.js

import React from 'react'
import { bindActionCreators } from 'redux'
import { connect } from 'react-redux'

import * as TodoActionCreators from './TodoActionCreators'
console.log(TodoActionCreators)
// {
//   addTodo: Function,
//   removeTodo: Function
// }

function TodoListContainer(props) {
  // Injected by react-redux:
  const { dispatch, todos } = props

  // Here's a good use case for bindActionCreators:
  // You want a child component to be completely unaware of Redux.
  // We create bound versions of these functions now so we can
  // pass them down to our child later.

  const boundActionCreators = useMemo(
    () => bindActionCreators(TodoActionCreators, dispatch),
    [dispatch]
  )
  console.log(boundActionCreators)
  // {
  //   addTodo: Function,
  //   removeTodo: Function
  // }

  useEffect(() => {
    // Note: this won't work:
    // TodoActionCreators.addTodo('Use Redux')

    // You're just calling a function that creates an action.
    // You must dispatch the action, too!

    // This will work:
    let action = TodoActionCreators.addTodo('Use Redux')
    dispatch(action)
  }, [])

  return <TodoList todos={todos} {...this.boundActionCreators} />

  // An alternative to bindActionCreators is to pass
  // just the dispatch function down, but then your child component
  // needs to import action creators and know about them.

  // return <TodoList todos={todos} dispatch={dispatch} />
}

export default connect(state => ({ todos: state.todos }))(TodoListContainer)