Skip to content

Commit 630e1be

Browse files
authored
There is no dash in the React Redux name. (#1141)
Removed all references to "React-Redux". That's probably some other library. I don't trust it.
1 parent 94799ef commit 630e1be

File tree

14 files changed

+46
-46
lines changed

14 files changed

+46
-46
lines changed

.github/ISSUE_TEMPLATE/---bug-report.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,4 +21,4 @@ about: Something isn't working correctly.
2121

2222

2323

24-
**Which versions of React, ReactDOM/React Native, Redux, and React-Redux are you using? Which browser and OS are affected by this issue? Did this work in previous versions of React-Redux?**
24+
**Which versions of React, ReactDOM/React Native, Redux, and React Redux are you using? Which browser and OS are affected by this issue? Did this work in previous versions of React Redux?**

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ If you are on an older version of React Native, you’ll need to keep using [Rea
2929

3030
## Documentation
3131

32-
The React-Redux docs are now published at **https://react-redux.js.org** .
32+
The React Redux docs are now published at **https://react-redux.js.org** .
3333

3434
We're currently expanding and rewriting our docs content - check back soon for more updates!
3535

docs/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
# Table of Contents
22

33
- Introduction
4-
- [Quick Start: adding React-Redux to a React todo app](./introduction/quick-start.md)
4+
- [Quick Start: adding React Redux to a React todo app](./introduction/quick-start.md)
55
- [Basic Tutorial](./introduction/basic-tutorial.md)
6-
- Using React-Redux
6+
- Using React Redux
77
- [Connect: Extracting Data with `mapStateToProps`](./using-react-redux/connect-extracting-data-with-mapStateToProps.md)
88
- [API](api.md#api)
99
- [`<Provider store>`](api.md#provider-store)

docs/api/Provider.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ sidebar_label: Provider
1010

1111
The `<Provider />` makes the Redux `store` available to any nested components that have been wrapped in the `connect()` function.
1212

13-
Since any React component in a React-Redux app can be connected, most applications will render a `<Provider>` at the top level, with the entire app’s component tree inside of it.
13+
Since any React component in a React Redux app can be connected, most applications will render a `<Provider>` at the top level, with the entire app’s component tree inside of it.
1414

1515
Normally, you can’t use a connected component unless it is nested inside of a `<Provider>` .
1616

docs/introduction/basic-tutorial.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ sidebar_label: Basic Tutorial
77

88
# Basic Tutorial
99

10-
To see how to use React-Redux in practice, we’ll show a step-by-step example by creating a todo list app.
10+
To see how to use React Redux in practice, we’ll show a step-by-step example by creating a todo list app.
1111

1212
## A Todo List Example
1313

@@ -24,7 +24,7 @@ We have implemented our React UI components as follows:
2424
- `TodoApp` is the entry component for our app. It renders the header, the `AddTodo`, `TodoList`, and `VisibilityFilters` components.
2525
- `AddTodo` is the component that allows a user to input a todo item and add to the list upon clicking its “Add Todo” button:
2626
- It uses a controlled input that sets state upon `onChange`.
27-
- When the user clicks on the “Add Todo” button, it dispatches the action (that we will provide using React-Redux) to add the todo to the store.
27+
- When the user clicks on the “Add Todo” button, it dispatches the action (that we will provide using React Redux) to add the todo to the store.
2828
- `TodoList` is the component that renders the list of todos:
2929
- It renders the filtered list of todos when one of the `VisibilityFilters` is selected.
3030
- `Todo` is the component that renders a single todo item:
@@ -66,11 +66,11 @@ You may check out [this CodeSandbox](https://codesandbox.io/s/6vwyqrpqk3) for th
6666

6767
<br />
6868

69-
We will now show how to connect this store to our app using React-Redux.
69+
We will now show how to connect this store to our app using React Redux.
7070

7171
### Providing the Store
7272

73-
First we need to make the `store` available to our app. To do this, we wrap our app with the `<Provider />` API provided by React-Redux.
73+
First we need to make the `store` available to our app. To do this, we wrap our app with the `<Provider />` API provided by React Redux.
7474

7575
```jsx
7676
// index.js
@@ -96,7 +96,7 @@ Notice how our `<TodoApp />` is now wrapped with the `<Provider />` with `store`
9696

9797
### Connecting the Components
9898

99-
React-Redux provides a `connect` function for you to read values from the Redux store (and re-read the values when the store updates).
99+
React Redux provides a `connect` function for you to read values from the Redux store (and re-read the values when the store updates).
100100

101101
The `connect` function takes two arguments, both optional:
102102

@@ -439,14 +439,14 @@ const mapStateToProps = state => {
439439
export default connect(mapStateToProps)(TodoList);
440440
```
441441

442-
Now we've finished a very simple example of a todo app with React-Redux. All our components are connected! Isn't that nice? 🎉🎊
442+
Now we've finished a very simple example of a todo app with React Redux. All our components are connected! Isn't that nice? 🎉🎊
443443

444444
![](https://i.imgur.com/ONqer2R.png)
445445

446446
## Links
447447

448448
- [Usage with React](https://redux.js.org/basics/usagewithreact)
449-
- [Using the React-Redux Bindings](https://blog.isquaredsoftware.com/presentations/workshops/redux-fundamentals/react-redux.html)
449+
- [Using the React Redux Bindings](https://blog.isquaredsoftware.com/presentations/workshops/redux-fundamentals/react-redux.html)
450450
- [Higher Order Components in Depth](https://medium.com/@franleplant/react-higher-order-components-in-depth-cf9032ee6c3e)
451451
- [Computing Derived Data](https://redux.js.org/recipes/computingderiveddata#sharing-selectors-across-multiple-components)
452452
- [Idiomatic Redux: Using Reselect Selectors for Encapsulation and Performance](https://blog.isquaredsoftware.com/2017/12/idiomatic-redux-using-reselect-selectors/)

docs/introduction/quick-start.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,13 @@ sidebar_label: Quick Start
77

88
# Quick Start
99

10-
[React-Redux](https://github.com/reduxjs/react-redux) is the official [React](https://reactjs.org/) binding for [Redux](https://redux.js.org/). It lets your React components read data from a Redux store, and dispatch actions to the store to update data.
10+
[React Redux](https://github.com/reduxjs/react-redux) is the official [React](https://reactjs.org/) binding for [Redux](https://redux.js.org/). It lets your React components read data from a Redux store, and dispatch actions to the store to update data.
1111

1212
## Installation
1313

14-
React-Redux version 6 requires **React 16.4 or later.**
14+
React Redux 6.x requires **React 16.4 or later.**
1515

16-
To use React-Redux with your React app:
16+
To use React Redux with your React app:
1717

1818
```bash
1919
npm install --save react-redux
@@ -29,7 +29,7 @@ You'll also need to [install Redux](https://redux-docs.netlify.com/introduction/
2929

3030
## `Provider` and `connect`
3131

32-
React-Redux provides `<Provider />`, which makes the Redux store available to the rest of your app:
32+
React Redux provides `<Provider />`, which makes the Redux store available to the rest of your app:
3333

3434
```js
3535
import React from "react";
@@ -49,7 +49,7 @@ ReactDOM.render(
4949
);
5050
```
5151

52-
React-Redux provides a `connect` function for you to connect your component to the store.
52+
React Redux provides a `connect` function for you to connect your component to the store.
5353

5454
Normally, you’ll call `connect` in this way:
5555

docs/introduction/why-use-react-redux.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
11
---
22
id: why-use-react-redux
3-
title: Why Use React-Redux?
3+
title: Why Use React Redux?
44
hide_title: true
5-
sidebar_label: Why Use React-Redux?
5+
sidebar_label: Why Use React Redux?
66
---
77

8-
# Why Use React-Redux?
8+
# Why Use React Redux?
99

1010
Redux itself is a standalone library that can be used with any UI layer or framework, including React, Angular, Vue, Ember, and vanilla JS. Although Redux and React are commonly used together, they are independent of each other.
1111

1212
If you are using Redux with any kind of UI framework, you will normally use a "UI binding" library to tie Redux together with your UI framework, rather than directly interacting with the store from your UI code.
1313

14-
**React-Redux is the official Redux UI binding library for React**. If you are using Redux and React together, you should also use React-Redux to bind these two libraries.
14+
**React Redux is the official Redux UI binding library for React**. If you are using Redux and React together, you should also use React Redux to bind these two libraries.
1515

16-
To understand why you should use React-Redux, it may help to understand what a "UI binding library" does.
16+
To understand why you should use React Redux, it may help to understand what a "UI binding library" does.
1717

1818
> **Note**: If you have questions about whether you should use Redux in general, please see these articles for discussion of when and why you might want to use Redux, and how it's intended to be used:
1919
>
@@ -38,18 +38,18 @@ Using Redux with _any_ UI layer requires [the same consistent set of steps](http
3838

3939
While it is possible to write this logic by hand, doing so would become very repetitive. In addition, optimizing UI performance would require complicated logic.
4040

41-
The process of subscribing to the store, checking for updated data, and triggering a re-render can be made more generic and reusable. **A UI binding library like React-Redux handles the store interaction logic, so you don't have to write that code yourself.**
41+
The process of subscribing to the store, checking for updated data, and triggering a re-render can be made more generic and reusable. **A UI binding library like React Redux handles the store interaction logic, so you don't have to write that code yourself.**
4242

43-
> **Note**: For a deeper look at how React-Redux works internally and how it handles the store interaction for you, see **[Idiomatic Redux: The History and Implementation of React-Redux](https://blog.isquaredsoftware.com/2018/11/react-redux-history-implementation/)**.
43+
> **Note**: For a deeper look at how React Redux works internally and how it handles the store interaction for you, see **[Idiomatic Redux: The History and Implementation of React Redux](https://blog.isquaredsoftware.com/2018/11/react-redux-history-implementation/)**.
4444
4545

46-
## Reasons to Use React-Redux
46+
## Reasons to Use React Redux
4747

4848
### It is the Official Redux UI Bindings for React
4949

50-
While Redux can be used with any UI layer, it was originally designed and intended for use with React. There are [UI binding layers for many other frameworks](https://redux.js.org/introduction/ecosystem#library-integration-and-bindings), but React-Redux is maintained directly by the Redux team.
50+
While Redux can be used with any UI layer, it was originally designed and intended for use with React. There are [UI binding layers for many other frameworks](https://redux.js.org/introduction/ecosystem#library-integration-and-bindings), but React Redux is maintained directly by the Redux team.
5151

52-
As the offical Redux binding for React, React-Redux is kept up-to-date with any API changes from either library, to ensure that your React components behave as expected. Its intended usage adopts the design principles of React - writing declarative components.
52+
As the offical Redux binding for React, React Redux is kept up-to-date with any API changes from either library, to ensure that your React components behave as expected. Its intended usage adopts the design principles of React - writing declarative components.
5353

5454

5555
### It Encourages Good React Architecture
@@ -58,7 +58,7 @@ React components are a lot like functions. While it's possible to write all you
5858

5959
Similarly, while you can write large React components that handle many different tasks, it's usually better to split up components based on responsibilities. In particular, it is common to have "container" components that are responsible for collecting and managing some kind of data, and "presentational" components that simply display UI based on whatever data they've received as props.
6060

61-
**The React-Redux `connect` function generates "container" wrapper components that handle the process of interacting with the store for you**. That way, your own components can focus on other tasks, whether it be collecting other data, or just displaying a piece of the UI. In addition, **`connect` abstracts away the question of _which_ store is being used, making your own components more reusable**.
61+
**The React Redux `connect` function generates "container" wrapper components that handle the process of interacting with the store for you**. That way, your own components can focus on other tasks, whether it be collecting other data, or just displaying a piece of the UI. In addition, **`connect` abstracts away the question of _which_ store is being used, making your own components more reusable**.
6262

6363
As a general architectural principle, **we want to keep our own components "unaware" of Redux**. They should simply receive data and functions as props, just like any other React component. This ultimately makes it easier to test and reuse your own components.
6464

@@ -67,33 +67,33 @@ As a general architectural principle, **we want to keep our own components "unaw
6767

6868
React is generally fast, but by default any updates to a component will cause React to re-render all of the components inside that part of the component tree. This does require work, and if the data for a given component hasn't changed, then re-rendering is likely some wasted effort because the requested UI output would be the same.
6969

70-
If performance is a concern, the best way to improve performance is to skip unnecessary re-renders, so that components only re-render when their data has actually changed. **React-Redux implements many performance optimizations internally, so that your own component only re-renders when it actually needs to.**
70+
If performance is a concern, the best way to improve performance is to skip unnecessary re-renders, so that components only re-render when their data has actually changed. **React Redux implements many performance optimizations internally, so that your own component only re-renders when it actually needs to.**
7171

7272
In addition, by connecting multiple components in your React component tree, you can ensure that each connected component only extracts the specific pieces of data from the store state that are needed by that component. This means that your own component will need to re-render less often, because most of the time those specific pieces of data haven't changed.
7373

7474

7575
### Community Support
7676

77-
As the official binding library for React and Redux, React-Redux has a large community of users. This makes it easier to ask for help, learn about best practices, use libraries that build on top of React-Redux, and reuse your knowledge across different applications.
77+
As the official binding library for React and Redux, React Redux has a large community of users. This makes it easier to ask for help, learn about best practices, use libraries that build on top of React Redux, and reuse your knowledge across different applications.
7878

7979

8080

8181
## Links and References
8282

8383

84-
### Understanding React-Redux
84+
### Understanding React Redux
8585

86-
- [Idiomatic Redux: The History and Implementation of React-Redux](https://blog.isquaredsoftware.com/2018/11/react-redux-history-implementation/)
86+
- [Idiomatic Redux: The History and Implementation of React Redux](https://blog.isquaredsoftware.com/2018/11/react-redux-history-implementation/)
8787
- [`connect.js` Explained](https://gist.github.com/gaearon/1d19088790e70ac32ea636c025ba424e)
8888
- [Redux Fundamentals workshop slides](https://blog.isquaredsoftware.com/2018/06/redux-fundamentals-workshop-slides/)
8989
- [UI Layer Integration](https://blog.isquaredsoftware.com/presentations/workshops/redux-fundamentals/ui-layer.html)
90-
- [Using React-Redux](https://blog.isquaredsoftware.com/presentations/workshops/redux-fundamentals/react-redux.html)
90+
- [Using React Redux](https://blog.isquaredsoftware.com/presentations/workshops/redux-fundamentals/react-redux.html)
9191

9292

9393
### Community Resources
9494

9595
- Discord channel: [#redux on Reactiflux](https://gist.github.com/gaearon/1d19088790e70ac32ea636c025ba424e) ([Reactiflux invite link](https://reactiflux.com))
96-
- Stack Overflow topics: [Redux](https://stackoverflow.com/questions/tagged/redux), [React-Redux](https://stackoverflow.com/questions/tagged/redux)
96+
- Stack Overflow topics: [Redux](https://stackoverflow.com/questions/tagged/redux), [React Redux](https://stackoverflow.com/questions/tagged/redux)
9797
- Reddit: [/r/reactjs](https://www.reddit.com/r/reactjs/), [/r/reduxjs](https://www.reddit.com/r/reduxjs/)
9898
- Github issues (bug reports and feature requests): https://github.com/reduxjs/react-redux/issues
9999
- Tutorials, articles, and further resources: [React/Redux Links](https://www.reddit.com/r/reduxjs/)

docs/using-react-redux/connect-dispatching-actions-with-mapDispatchToProps.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@ As the second argument passed in to `connect`, `mapDispatchToProps` is used for
1212
`dispatch` is a function of the Redux store. You call `store.dispatch` to dispatch an action.
1313
This is the only way to trigger a state change.
1414

15-
With React-Redux, your components never access the store directly - `connect` does it for you.
16-
React-Redux gives you two ways to let components dispatch actions:
15+
With React Redux, your components never access the store directly - `connect` does it for you.
16+
React Redux gives you two ways to let components dispatch actions:
1717

1818
- By default, a connected component receives `props.dispatch` and can dispatch actions itself.
1919
- `connect` can accept an argument called `mapDispatchToProps`, which lets you create functions that dispatch when called, and pass those functions as props to your component.
@@ -92,7 +92,7 @@ const TodoList = ({ todos, toggleTodo }) => (
9292
);
9393
```
9494

95-
This is what React-Redux’s `connect` does — it encapsulates the logic of talking to the Redux store and lets you not worry about it. And this is what you should totally make full use of in your implementation.
95+
This is what React Redux’s `connect` does — it encapsulates the logic of talking to the Redux store and lets you not worry about it. And this is what you should totally make full use of in your implementation.
9696

9797
## Two Forms of `mapDispatchToProps`
9898

@@ -281,7 +281,7 @@ Note that:
281281
- Your component will no longer receive `dispatch` as a prop
282282

283283
```js
284-
// React-Redux does this for you automatically:
284+
// React Redux does this for you automatically:
285285
dispatch => bindActionCreators(mapDispatchToProps, dispatch);
286286
```
287287

@@ -385,7 +385,7 @@ connect(
385385

386386
### Can I call `store.dispatch`?
387387

388-
It's an anti-pattern to interact with the store directly in a React component, whether it's an explicit import of the store or accessing it via context (see the [Redux FAQ entry on store setup](https://redux.js.org/faq/storesetup#can-or-should-i-create-multiple-stores-can-i-import-my-store-directly-and-use-it-in-components-myself) for more details). Let React-Redux’s `connect` handle the access to the store, and use the `dispatch` it passes to the props to dispatch actions.
388+
It's an anti-pattern to interact with the store directly in a React component, whether it's an explicit import of the store or accessing it via context (see the [Redux FAQ entry on store setup](https://redux.js.org/faq/storesetup#can-or-should-i-create-multiple-stores-can-i-import-my-store-directly-and-use-it-in-components-myself) for more details). Let React Redux’s `connect` handle the access to the store, and use the `dispatch` it passes to the props to dispatch actions.
389389

390390
## Links and References
391391

0 commit comments

Comments
 (0)