[d24f17c] | 1 | # React Redux
|
---|
| 2 |
|
---|
| 3 | Official React bindings for [Redux](https://github.com/reduxjs/redux).
|
---|
| 4 | Performant and flexible.
|
---|
| 5 |
|
---|
| 6 |  [](https://www.npmjs.com/package/react-redux)
|
---|
| 7 | [](https://www.npmjs.com/package/react-redux)
|
---|
| 8 | [](http://www.reactiflux.com)
|
---|
| 9 |
|
---|
| 10 | ## Installation
|
---|
| 11 |
|
---|
| 12 | ### Create a React Redux App
|
---|
| 13 |
|
---|
| 14 | The recommended way to start new apps with React and Redux is by using [our official Redux+TS template for Vite](https://github.com/reduxjs/redux-templates), or by creating a new Next.js project using [Next's `with-redux` template](https://github.com/vercel/next.js/tree/canary/examples/with-redux).
|
---|
| 15 |
|
---|
| 16 | Both of these already have Redux Toolkit and React-Redux configured appropriately for that build tool, and come with a small example app that demonstrates how to use several of Redux Toolkit's features.
|
---|
| 17 |
|
---|
| 18 | ```bash
|
---|
| 19 | # Vite with our Redux+TS template
|
---|
| 20 | # (using the `degit` tool to clone and extract the template)
|
---|
| 21 | npx degit reduxjs/redux-templates/packages/vite-template-redux my-app
|
---|
| 22 |
|
---|
| 23 | # Next.js using the `with-redux` template
|
---|
| 24 | npx create-next-app --example with-redux my-app
|
---|
| 25 | ```
|
---|
| 26 |
|
---|
| 27 | ### An Existing React App
|
---|
| 28 |
|
---|
| 29 | React Redux 8.0 requires **React 16.8.3 or later** (or React Native 0.59 or later).
|
---|
| 30 |
|
---|
| 31 | To use React Redux with your React app, install it as a dependency:
|
---|
| 32 |
|
---|
| 33 | ```bash
|
---|
| 34 | # If you use npm:
|
---|
| 35 | npm install react-redux
|
---|
| 36 |
|
---|
| 37 | # Or if you use Yarn:
|
---|
| 38 | yarn add react-redux
|
---|
| 39 | ```
|
---|
| 40 |
|
---|
| 41 | You'll also need to [install Redux](https://redux.js.org/introduction/installation) and [set up a Redux store](https://redux.js.org/recipes/configuring-your-store/) in your app.
|
---|
| 42 |
|
---|
| 43 | This assumes that you’re using [npm](http://npmjs.com/) package manager
|
---|
| 44 | with a module bundler like [Webpack](https://webpack.js.org/) or
|
---|
| 45 | [Browserify](http://browserify.org/) to consume [CommonJS
|
---|
| 46 | modules](https://webpack.js.org/api/module-methods/#commonjs).
|
---|
| 47 |
|
---|
| 48 | If you don’t yet use [npm](http://npmjs.com/) or a modern module bundler, and would rather prefer a single-file [UMD](https://github.com/umdjs/umd) build that makes `ReactRedux` available as a global object, you can grab a pre-built version from [cdnjs](https://cdnjs.com/libraries/react-redux). We _don’t_ recommend this approach for any serious application, as most of the libraries complementary to Redux are only available on [npm](http://npmjs.com/).
|
---|
| 49 |
|
---|
| 50 | ## Documentation
|
---|
| 51 |
|
---|
| 52 | The React Redux docs are published at **https://react-redux.js.org** .
|
---|
| 53 |
|
---|
| 54 | ## How Does It Work?
|
---|
| 55 |
|
---|
| 56 | The post [The History and Implementation of React-Redux](https://blog.isquaredsoftware.com/2018/11/react-redux-history-implementation/)
|
---|
| 57 | explains what it does, how it works, and how the API and implementation have evolved over time.
|
---|
| 58 |
|
---|
| 59 | There's also a [Deep Dive into React-Redux](https://blog.isquaredsoftware.com/2019/06/presentation-react-redux-deep-dive/) talk that covers some of the same material at a higher level.
|
---|
| 60 |
|
---|
| 61 | ## License
|
---|
| 62 |
|
---|
| 63 | [MIT](LICENSE.md)
|
---|