Skip to content
The official, opinionated, batteries-included toolset for efficient Redux development
TypeScript JavaScript CSS
Branch: master
Clone or download
phryneas and markerikson * refactor actionCreator typings from `type` to `interface` (#273)
* upgrade tsdx, re-introduce api-extractor

* * refactor actionCreator typings from `type` to `interface`
so that they keep their name in TS errors & tooltips
* fix order of operation for PayloadActionCreator

* fix for TS 3.3

* minor tweaks, add test for createSlice

* add updated api report
Latest commit aed0e4b Dec 14, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.codesandbox use rtk-github-issues-example for PR CodeSandboxes (#254) Nov 14, 2019
docs Fix typo in getDefaultMiddleware.md (#279) Dec 13, 2019
etc * refactor actionCreator typings from `type` to `interface` (#273) Dec 14, 2019
src * refactor actionCreator typings from `type` to `interface` (#273) Dec 14, 2019
type-tests * refactor actionCreator typings from `type` to `interface` (#273) Dec 14, 2019
website Add "Usage with TypeScript" section to the docs (#267) Dec 1, 2019
.eslintrc.js chore(build): swap in tsdx (#212) Oct 18, 2019
.gitignore * refactor actionCreator typings from `type` to `interface` (#273) Dec 14, 2019
.prettierignore * refactor actionCreator typings from `type` to `interface` (#273) Dec 14, 2019
.prettierrc.json Use Redux's prettier config Mar 15, 2018
.travis.yml also run travis tests with the current release candidate (#234) Oct 31, 2019
CNAME Rename RSK to Redux Toolkit (#250) Nov 13, 2019
LICENSE Create LICENSE Mar 3, 2018
README.md Update README.md Dec 3, 2019
api-extractor.json * refactor actionCreator typings from `type` to `interface` (#273) Dec 14, 2019
netlify.toml WiP: Integrate docusaurus 2 (#247) Nov 19, 2019
package-lock.json * refactor actionCreator typings from `type` to `interface` (#273) Dec 14, 2019
package.json * refactor actionCreator typings from `type` to `interface` (#273) Dec 14, 2019
tsconfig.json chore(build): swap in tsdx (#212) Oct 18, 2019
tsdx.config.js Fix module bundling & ESM runtime error (#280) Dec 14, 2019

README.md

Redux Toolkit

build status npm version npm downloads npm downloads

The official, opinionated, batteries-included toolset for efficient Redux development

npm install @reduxjs/toolkit

(Formerly known as "Redux Starter Kit")

Purpose

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:

  • "Configuring a Redux store is too complicated"
  • "I have to add a lot of packages to get Redux to do anything useful"
  • "Redux requires too much boilerplate code"

We can't solve every use case, but in the spirit of create-react-app and apollo-boost, 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.

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.

What's Included

Redux Toolkit includes:

  • 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.
  • 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 to let you write simpler immutable updates with normal mutative code, like state.todos[3].completed = true.
  • A createAction() utility that returns an action creator function for the given action type string. The function itself has toString() defined, so that it can be used in place of the type constant.
  • A createSlice() function that accepts a set of reducer functions, a slice name, and an initial state value, and automatically generates a slice reducer with corresponding action creators and action types.
  • The createSelector utility from the Reselect library, re-exported for ease of use.

Documentation

The Redux Toolkit docs are available at https://redux-toolkit.js.org.

You can’t perform that action at this time.