You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* Rework Quick Start and Usage Guide
* Update sidebar to rename Usage and remove "Examples"
* Update tutorials, except for sandbox links
* Update API docs
* Update Docusaurus site config
* Update test issue URLs
* Update package name in config files
* Update README
* Clean up irrelevant redirects and dead examples page
* Change UMD global name
* Try aligning badges
* More alignment
* Aligning...
* Mark scoped package as public
* Fix package name
* 1.0.2
* Update description
* Add netlify.toml file for build preview
* Fix CodeSandbox CI file
* Really fix package name i mean it
* 1.0.3
**A simple set of tools to make using Redux easier**
10
-
11
-
`npm install redux-starter-kit`
12
-
13
-
(Special thanks to Github user @shotak for donating to the package name.)
12
+
(Formerly known as "Redux Starter Kit")
14
13
15
14
### Purpose
16
15
17
-
The Redux Starter Kit package is intended to help address three common concerns about Redux:
16
+
The **Redux Toolkit**package is intended to be the standard way to write Redux logic. It was originally created to help address three common concerns about Redux:
18
17
19
18
- "Configuring a Redux store is too complicated"
20
19
- "I have to add a lot of packages to get Redux to do anything useful"
21
20
- "Redux requires too much boilerplate code"
22
21
23
22
We can't solve every use case, but in the spirit of [`create-react-app`](https://github.com/facebook/create-react-app) and [`apollo-boost`](https://dev-blog.apollodata.com/zero-config-graphql-state-management-27b1f1b3c2c3), we can try to provide some tools that abstract over the setup process and handle the most common use cases, as well as include some useful utilities that will let the user simplify their application code.
24
23
25
-
This package is _not_ intended to solve every possible concern about Redux, and is deliberately limited in scope. It does _not_ address concepts like "reusable encapsulated Redux modules", data fetching, folder or file structures, managing entity relationships in the store, and so on.
24
+
This package is _not_ intended to solve every possible use case for Redux, and is deliberately limited in scope. It does _not_ address concepts like "reusable encapsulated Redux modules", data fetching, folder or file structures, managing entity relationships in the store, and so on.
26
25
27
26
### What's Included
28
27
29
-
Redux Starter Kit includes:
28
+
Redux Toolkit includes:
30
29
31
30
- A `configureStore()` function with simplified configuration options. It can automatically combine your slice reducers, adds whatever Redux middleware you supply, includes `redux-thunk` by default, and enables use of the Redux DevTools Extension.
32
31
- A `createReducer()` utility that lets you supply a lookup table of action types to case reducer functions, rather than writing switch statements. In addition, it automatically uses the [`immer` library](https://github.com/mweststrate/immer) to let you write simpler immutable updates with normal mutative code, like `state.todos[3].completed = true`.
@@ -36,6 +35,4 @@ Redux Starter Kit includes:
36
35
37
36
## Documentation
38
37
39
-
The Redux Starter Kit docs are now published at **https://redux-starter-kit.js.org**.
40
-
41
-
We're currently expanding and rewriting our docs content - check back soon for more updates!
38
+
The Redux Toolkit docs are available at **https://redux-toolkit.js.org**.
Copy file name to clipboardExpand all lines: docs/api/createAction.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -103,7 +103,7 @@ This works because object keys that are not natively supported by JavaScript (li
103
103
104
104
In principle, Redux lets you use any kind of value as an action type. Instead of strings, you could theoretically use numbers, [symbols](https://developer.mozilla.org/en-US/docs/Glossary/Symbol), or anything else ([although it's recommended that the value should at least be serializable](https://redux.js.org/faq/actions#why-should-type-be-a-string-or-at-least-serializable-why-should-my-action-types-be-constants)).
105
105
106
-
However, Redux Starter Kit rests on the assumption that you use string action types. Specifically, some of its features rely on the fact that with strings, the `toString()` method of an `createAction()` action creator returns the matching action type. This is not the case for non-string action types because `toString()` will return the string-converted type value rather than the type itself.
106
+
However, Redux Toolkit rests on the assumption that you use string action types. Specifically, some of its features rely on the fact that with strings, the `toString()` method of an `createAction()` action creator returns the matching action type. This is not the case for non-string action types because `toString()` will return the string-converted type value rather than the type itself.
Copy file name to clipboardExpand all lines: docs/api/createSelector.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,6 +16,6 @@ For more details on using `createSelector`, see:
16
16
-[Idiomatic Redux: Using Reselect Selectors for Encapsulation and Performance](https://blog.isquaredsoftware.com/2017/12/idiomatic-redux-using-reselect-selectors/)
17
17
-[React/Redux Links: Reducers and Selectors](https://github.com/markerikson/react-redux-links/blob/master/redux-reducers-selectors.md)
18
18
19
-
> **Note**: Prior to v0.7, RSK re-exported `createSelector` from [`selectorator`](https://github.com/planttheidea/selectorator), which
19
+
> **Note**: Prior to v0.7, RTK re-exported `createSelector` from [`selectorator`](https://github.com/planttheidea/selectorator), which
20
20
> allowed using string keypaths as input selectors. This was removed, as it ultimately did not provide enough benefits, and
21
21
> the string keypaths made static typing for selectors difficult.
Copy file name to clipboardExpand all lines: docs/introduction/quick-start.md
+11-7Lines changed: 11 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,7 +9,7 @@ hide_title: true
9
9
10
10
## Purpose
11
11
12
-
The **Redux Starter Kit** package is intended to help address three common concerns about Redux:
12
+
The **Redux Toolkit** package is intended to be the standard way to write Redux logic. It was originally created to help address three common concerns about Redux:
13
13
14
14
- "Configuring a Redux store is too complicated"
15
15
- "I have to add a lot of packages to get Redux to do anything useful"
@@ -20,12 +20,12 @@ We can't solve every use case, but in the spirit of [`create-react-app`](https:/
20
20
This package is _not_ intended to solve every possible concern about Redux, and is deliberately limited in scope. It does _not_ address concepts like "reusable encapsulated Redux modules", data fetching, folder or file structures, managing entity relationships in the store, and so on.
21
21
22
22
That said, **these tools should be beneficial to all Redux users**. Whether you're a brand new Redux user setting up your
23
-
first project, or an experienced user who wants to simplify an existing application, **Redux Starter Kit** can help
23
+
first project, or an experienced user who wants to simplify an existing application, **Redux Toolkit** can help
24
24
you make your Redux code better.
25
25
26
26
## What's Included
27
27
28
-
Redux Starter Kit includes:
28
+
Redux Toolkit includes:
29
29
30
30
- A [`configureStore()` function](../api/configureStore.md) with simplified configuration options. It can automatically combine your slice reducers, adds whatever Redux middleware you supply, includes `redux-thunk` by default, and enables use of the Redux DevTools Extension.
31
31
- A [`createReducer()` utility](../api/createReducer.md) that lets you supply a lookup table of action types to case reducer functions, rather than writing switch statements. In addition, it automatically uses the [`immer` library](https://github.com/mweststrate/immer) to let you write simpler immutable updates with normal mutative code, like `state.todos[3].completed = true`.
@@ -35,14 +35,18 @@ Redux Starter Kit includes:
35
35
36
36
## Installation
37
37
38
-
Redux Starter Kit is available as a package on NPM for use with a module bundler or in a Node application:
38
+
Redux Toolkit is available as a package on NPM for use with a module bundler or in a Node application:
39
39
40
40
```bash
41
-
npm install --save redux-starter-kit
41
+
# NPM
42
+
npm install --save @reduxjs/toolkit
43
+
44
+
# Yarn
45
+
yarn add @reduxjs/toolkit
42
46
```
43
47
44
-
It is also available as a precompiled UMD package that defines a `window['redux-starter-kit']` global variable.
45
-
The UMD package can be used as a [`<script>` tag](https://unpkg.com/redux-starter-kit/dist/redux-starter-kit.umd.js) directly.
48
+
It is also available as a precompiled UMD package that defines a `window.RTK` global variable.
49
+
The UMD package can be used as a [`<script>` tag](https://unpkg.com/@reduxjs/toolkit/dist/redux-toolkit.umd.js) directly.
0 commit comments