Repository files navigation

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

(Formerly known as "Redux Starter Kit")

The recommended way to start new apps with React and Redux Toolkit is by using theofficial Redux+JS template forCreate React App, which takes advantage of React Redux's integration with React components.

npx create-react-app my-app --template redux

Redux Toolkit is available as a package on NPM for use with a module bundler or in a Node application:

# NPMnpm install @reduxjs/toolkit# Yarnyarn add @reduxjs/toolkit

It is also available as a precompiled UMD package that defines awindow.RTK global variable.The UMD package can be used as a<script> tag directly.

TheRedux 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 ofcreate-react-app andapollo-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.

Because of that, this package is deliberately limited in scope. It doesnot address concepts like "reusable encapsulated Redux modules", data caching, folder or file structures, managing entity relationships in the store, and so on.

Redux Toolkit includes these APIs:

• configureStore(): wrapscreateStore to provide simplified configuration options and good defaults. It can automatically combine your slice reducers, adds whatever Redux middleware you supply, includesredux-thunk by default, and enables use of the Redux DevTools Extension.
• createReducer(): that lets you supply a lookup table of action types to case reducer functions, rather than writing switch statements. In addition, it automatically uses theimmer library to let you write simpler immutable updates with normal mutative code, likestate.todos[3].completed = true.
• createAction(): generates an action creator function for the given action type string. The function itself hastoString() defined, so that it can be used in place of the type constant.
• createSlice(): accepts an object of reducer functions, a slice name, and an initial state value, and automatically generates a slice reducer with corresponding action creators and action types.
• createAsyncThunk: accepts an action type string and a function that returns a promise, and generates a thunk that dispatchespending/resolved/rejected action types based on that promise
• createEntityAdapter: generates a set of reusable reducers and selectors to manage normalized data in the store
• ThecreateSelector utility from theReselect library, re-exported for ease of use.

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