-
-
Notifications
You must be signed in to change notification settings - Fork 3.4k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Removed `connectAdvanced` and `pure` descriptions - Updated all `render()` examples to show `createRoot` - Added note that `batch` isn't needed with React 18 - Added TS props for `Provider` and documented `serverState` - Updated TS usage descriptions - Added warnings about `@types/react@18`
- Loading branch information
1 parent
1da5216
commit 885c1cc
Showing
12 changed files
with
147 additions
and
190 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -5,21 +5,25 @@ Performant and flexible. | |
|
||
![GitHub Workflow Status](https://img.shields.io/github/workflow/status/reduxjs/react-redux/Tests?style=flat-square) [![npm version](https://img.shields.io/npm/v/react-redux.svg?style=flat-square)](https://www.npmjs.com/package/react-redux) | ||
[![npm downloads](https://img.shields.io/npm/dm/react-redux.svg?style=flat-square)](https://www.npmjs.com/package/react-redux) | ||
[![redux channel on discord](https://img.shields.io/badge/[email protected]?style=flat-square)](http://www.reactiflux.com) | ||
[![#redux channel on Discord](https://img.shields.io/badge/[email protected]?style=flat-square)](http://www.reactiflux.com) | ||
|
||
## Installation | ||
|
||
### Using Create React App | ||
|
||
The recommended way to start new apps with React Redux is by using the [official Redux+JS template](https://github.com/reduxjs/cra-template-redux) for [Create React App](https://github.com/facebook/create-react-app), which takes advantage of [Redux Toolkit](https://redux-toolkit.js.org/). | ||
The recommended way to start new apps with React Redux is by using the [official Redux+JS/TS templates](https://github.com/reduxjs/cra-template-redux) for [Create React App](https://github.com/facebook/create-react-app), which takes advantage of [Redux Toolkit](https://redux-toolkit.js.org/). | ||
|
||
```sh | ||
# JS | ||
npx create-react-app my-app --template redux | ||
|
||
# TS | ||
npx create-react-app my-app --template redux-typescript | ||
``` | ||
|
||
### An Existing React App | ||
|
||
React Redux 7.1 requires **React 16.8.3 or later.** | ||
React Redux 8.0 requires **React 16.8.3 or later** (or React Native 0.59 or later). | ||
|
||
To use React Redux with your React app, install it as a dependency: | ||
|
||
|
@@ -40,24 +44,16 @@ modules](https://webpack.js.org/api/module-methods/#commonjs). | |
|
||
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/). | ||
|
||
## React Native | ||
|
||
As of React Native 0.18, React Redux 5.x should work with React Native. If you have any issues with React Redux 5.x on React Native, run `npm ls react` and make sure you don’t have a duplicate React installation in your `node_modules`. We recommend that you use `[email protected]` which is better at avoiding these kinds of issues. | ||
|
||
## Documentation | ||
|
||
The React Redux docs are now published at **https://react-redux.js.org** . | ||
|
||
We're currently expanding and rewriting our docs content - check back soon for more updates! | ||
The React Redux docs are published at **https://react-redux.js.org** . | ||
|
||
## How Does It Work? | ||
|
||
We do a deep dive on how React Redux works in [this readthesource episode](https://www.youtube.com/watch?v=VJ38wSFbM3A). | ||
|
||
Also, the post [The History and Implementation of React-Redux](https://blog.isquaredsoftware.com/2018/11/react-redux-history-implementation/) | ||
The post [The History and Implementation of React-Redux](https://blog.isquaredsoftware.com/2018/11/react-redux-history-implementation/) | ||
explains what it does, how it works, and how the API and implementation have evolved over time. | ||
|
||
Enjoy! | ||
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. | ||
|
||
## License | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.