Accessing the Store
React Redux provides APIs that allow your components to dispatch actions and subscribe to data updates from the store.
As part of that, React Redux abstracts away the details of which store you are using, and the exact details of how that store interaction is handled. In typical usage, your own components should never need to care about those details, and won't ever reference the store directly. React Redux also internally handles the details of how the store and state are propagated to connected components, so that this works as expected by default.
However, there may be certain use cases where you may need to customize how the store and state are propagated to connected components, or access the store directly. Here are some examples of how to do this.
Understanding Context Usage
Internally, React Redux uses React's "context" feature to make the
Redux store accessible to deeply nested connected components. As of React Redux version 6, this is normally handled
by a single default context object instance generated by
<Provider> component uses
<ReactReduxContext.Provider> to put the Redux store and the current store
state into context, and
<ReactReduxContext.Consumer> to read those values and handle updates.
Providing Custom Context
Instead of using the default context instance from React Redux, you may supply your own custom context instance.
If you supply a custom context, React Redux will use that context instance instead of the one it creates and exports by default.
After you’ve supplied the custom context to
<Provider />, you will need to supply this context instance to all of your connected components that are expected to connect to the same store:
The following runtime error occurs when React Redux does not find a store in the context it is looking. For example:
- You provided a custom context instance to
<Provider />, but did not provide the same instance (or did not provide any) to your connected components.
- You provided a custom context to your connected component, but did not provide the same instance (or did not provide any) to
Could not find "store" in the context of "Connect(MyComponent)". Either wrap the root component in a
<Provider>, or pass a custom React context provider to
<Provider>and the corresponding React context consumer to Connect(Todo) in connect options.
Redux was designed to use a single store. However, if you are in an unavoidable position of needing to use multiple stores, with v6 you may do so by providing (multiple) custom contexts. This also provides a natural isolation of the stores as they live in separate context instances.
In rare cases, you may need to access the Redux store directly in your own components. This can be done by rendering
the appropriate context consumer yourself, and accessing the
store field out of the context value.
Note: This is not considered part of the React Redux public API, and may break without notice. We do recognize that the community has use cases where this is necessary, and will try to make it possible for users to build additional functionality on top of React Redux, but our specific use of context is considered an implementation detail. If you have additional use cases that are not sufficiently covered by the current APIs, please file an issue to discuss possible API improvements.
- CodeSandbox example: A reading list app with theme using a separate store, implemented by providing (multiple) custom context(s).
- Related issues: