connect
Connects a React component to a Redux store. connect
is a facade around connectAdvanced
, providing a convenient API for the most common use cases.
It does not modify the component class passed to it; instead, it returns a new, connected component class for you to use.
Arguments
[
mapStateToProps(state, [ownProps]): stateProps
] (Function): If this argument is specified, the new component will subscribe to Redux store updates. This means that any time the store is updated,mapStateToProps
will be called. The results ofmapStateToProps
must be a plain object, which will be merged into the component’s props. If you don't want to subscribe to store updates, passnull
orundefined
in place ofmapStateToProps
.If your
mapStateToProps
function is declared as taking two parameters, it will be called with the store state as the first parameter and the props passed to the connected component as the second parameter, and will also be re-invoked whenever the connected component receives new props as determined by shallow equality comparisons. (The second parameter is normally referred to asownProps
by convention.)Note: in advanced scenarios where you need more control over the rendering performance,
mapStateToProps()
can also return a function. In this case, that function will be used asmapStateToProps()
for a particular component instance. This allows you to do per-instance memoization. You can refer to #279 and the tests it adds for more details. Most apps never need this.The
mapStateToProps
function's first argument is the entire Redux store’s state and it returns an object to be passed as props. It is often called a selector. Use reselect to efficiently compose selectors and compute derived data.[
mapDispatchToProps(dispatch, [ownProps]): dispatchProps
] (Object or Function): If an object is passed, each function inside it is assumed to be a Redux action creator. An object with the same function names, but with every action creator wrapped into adispatch
call so they may be invoked directly, will be merged into the component’s props.If a function is passed, it will be given
dispatch
as the first parameter. It’s up to you to return an object that somehow usesdispatch
to bind action creators in your own way. (Tip: you may use thebindActionCreators()
helper from Redux.)If your
mapDispatchToProps
function is declared as taking two parameters, it will be called withdispatch
as the first parameter and the props passed to the connected component as the second parameter, and will be re-invoked whenever the connected component receives new props. (The second parameter is normally referred to asownProps
by convention.)If you do not supply your own
mapDispatchToProps
function or object full of action creators, the defaultmapDispatchToProps
implementation just injectsdispatch
into your component’s props.Note: in advanced scenarios where you need more control over the rendering performance,
mapDispatchToProps()
can also return a function. In this case, that function will be used asmapDispatchToProps()
for a particular component instance. This allows you to do per-instance memoization. You can refer to #279 and the tests it adds for more details. Most apps never need this.[
mergeProps(stateProps, dispatchProps, ownProps): props
] (Function): If specified, it is passed the result ofmapStateToProps()
,mapDispatchToProps()
, and the parentprops
. The plain object you return from it will be passed as props to the wrapped component. You may specify this function to select a slice of the state based on props, or to bind action creators to a particular variable from props. If you omit it,Object.assign({}, ownProps, stateProps, dispatchProps)
is used by default.[
options
] (Object) If specified, further customizes the behavior of the connector. In addition to the options passable toconnectAdvanced()
(see those below),connect()
accepts these additional options:[
pure
] (Boolean): If true,connect()
will avoid re-renders and calls tomapStateToProps
,mapDispatchToProps
, andmergeProps
if the relevant state/props objects remain equal based on their respective equality checks. Assumes that the wrapped component is a “pure” component and does not rely on any input or state other than its props and the selected Redux store’s state. Default value:true
[
areStatesEqual
] (Function): When pure, compares incoming store state to its previous value. Default value:strictEqual (===)
[
areOwnPropsEqual
] (Function): When pure, compares incoming props to its previous value. Default value:shallowEqual
[
areStatePropsEqual
] (Function): When pure, compares the result ofmapStateToProps
to its previous value. Default value:shallowEqual
[
areMergedPropsEqual
] (Function): When pure, compares the result ofmergeProps
to its previous value. Default value:shallowEqual
[
storeKey
] (String): The key of the context from where to read the store. You probably only need this if you are in the inadvisable position of having multiple stores. Default value:'store'
The arity of mapStateToProps and mapDispatchToProps determines whether they receive ownProps
Note:
ownProps
is not passed tomapStateToProps
andmapDispatchToProps
if the formal definition of the function contains one mandatory parameter (function has length 1). For example, functions defined like below won't receiveownProps
as the second argument.
Functions with no mandatory parameters or two parameters will receive ownProps
.
Optimizing connect when options.pure is true
When options.pure
is true, connect
performs several equality checks that are used to avoid unnecessary calls to mapStateToProps
, mapDispatchToProps
, mergeProps
, and ultimately to render
. These include areStatesEqual
, areOwnPropsEqual
, areStatePropsEqual
, and areMergedPropsEqual
. While the defaults are probably appropriate 99% of the time, you may wish to override them with custom implementations for performance or other reasons. Here are several examples:
You may wish to override
areStatesEqual
if yourmapStateToProps
function is computationally expensive and is also only concerned with a small slice of your state. For example:areStatesEqual: (next, prev) => prev.entities.todos === next.entities.todos
; this would effectively ignore state changes for everything but that slice of state.You may wish to override
areStatesEqual
to always return false (areStatesEqual: () => false
) if you have impure reducers that mutate your store state. (This would likely impact the other equality checks as well, depending on yourmapStateToProps
function.)You may wish to override
areOwnPropsEqual
as a way to whitelist incoming props. You'd also have to implementmapStateToProps
,mapDispatchToProps
andmergeProps
to also whitelist props. (It may be simpler to achieve this other ways, for example by using recompose's mapProps.)You may wish to override
areStatePropsEqual
to usestrictEqual
if yourmapStateToProps
uses a memoized selector that will only return a new object if a relevant prop has changed. This would be a very slight performance improvement, since would avoid extra equality checks on individual props each timemapStateToProps
is called.You may wish to override
areMergedPropsEqual
to implement adeepEqual
if your selectors produce complex props. ex: nested objects, new arrays, etc. (The deep equal check should be faster than just re-rendering.)
Returns
A higher-order React component class that passes state and action creators into your component derived from the supplied arguments. This is created by connectAdvanced
, and details of this higher-order component are covered there.
Examples
Inject just dispatch
and don't listen to store
dispatch
and don't listen to storeInject all action creators (addTodo
, completeTodo
, ...) without subscribing to the store
addTodo
, completeTodo
, ...) without subscribing to the storeInject dispatch
and every field in the global state
dispatch
and every field in the global stateDon’t do this! It kills any performance optimizations because
TodoApp
will rerender after every state change. It’s better to have more granularconnect()
on several components in your view hierarchy that each only listen to a relevant slice of the state.
Inject dispatch
and todos
dispatch
and todos
Inject todos
and all action creators
todos
and all action creatorsInject todos
and all action creators (addTodo
, completeTodo
, ...) as actions
todos
and all action creators (addTodo
, completeTodo
, ...) as actions
Inject todos
and a specific action creator (addTodo
)
todos
and a specific action creator (addTodo
)Inject todos
and specific action creators (addTodo
and deleteTodo
) with shorthand syntax
todos
and specific action creators (addTodo
and deleteTodo
) with shorthand syntaxInject todos
, todoActionCreators as todoActions
, and counterActionCreators as counterActions
todos
, todoActionCreators as todoActions
, and counterActionCreators as counterActions
Inject todos
, and todoActionCreators and counterActionCreators together as actions
todos
, and todoActionCreators and counterActionCreators together as actions
Inject todos
, and all todoActionCreators and counterActionCreators directly as props
todos
, and all todoActionCreators and counterActionCreators directly as propsInject todos
of a specific user depending on props
todos
of a specific user depending on propsInject todos
of a specific user depending on props, and inject props.userId
into the action
todos
of a specific user depending on props, and inject props.userId
into the actionFactory functions
Factory functions can be used for performance optimizations
Last updated