redux-toolkit
The official, opinionated, batteries-included toolset for efficient Redux development
Top Related Projects
Quick Overview
Redux Toolkit is the official, opinionated, batteries-included toolset for efficient Redux development. It simplifies the process of writing Redux logic, reduces boilerplate code, and includes powerful features like Redux Thunk for async actions and Immer for immutable state updates.
Pros
- Simplifies Redux setup and configuration
- Reduces boilerplate code with utility functions
- Includes built-in middleware for common use cases (e.g., Redux Thunk)
- Encourages best practices and standardized Redux patterns
Cons
- Learning curve for developers new to Redux concepts
- May be overkill for small projects or simple state management needs
- Opinionated approach might not fit all project structures or preferences
- Potential performance overhead for very large applications
Code Examples
Creating a slice with Redux Toolkit:
import { createSlice } from '@reduxjs/toolkit'
const counterSlice = createSlice({
name: 'counter',
initialState: 0,
reducers: {
increment: state => state + 1,
decrement: state => state - 1,
},
})
export const { increment, decrement } = counterSlice.actions
export default counterSlice.reducer
Using createAsyncThunk for async actions:
import { createAsyncThunk, createSlice } from '@reduxjs/toolkit'
const fetchUserById = createAsyncThunk(
'users/fetchByIdStatus',
async (userId, thunkAPI) => {
const response = await fetch(`https://api.example.com/users/${userId}`)
return response.json()
}
)
const userSlice = createSlice({
name: 'user',
initialState: { entities: [], loading: 'idle' },
reducers: {},
extraReducers: (builder) => {
builder.addCase(fetchUserById.fulfilled, (state, action) => {
state.entities.push(action.payload)
})
},
})
Configuring the store:
import { configureStore } from '@reduxjs/toolkit'
import counterReducer from './counterSlice'
import userReducer from './userSlice'
const store = configureStore({
reducer: {
counter: counterReducer,
user: userReducer,
},
})
export default store
Getting Started
To start using Redux Toolkit, first install it via npm:
npm install @reduxjs/redux-toolkit
Then, create a store file (e.g., store.js):
import { configureStore } from '@reduxjs/toolkit'
import rootReducer from './reducers'
const store = configureStore({
reducer: rootReducer,
})
export default store
Finally, wrap your React app with the Redux Provider:
import React from 'react'
import { Provider } from 'react-redux'
import store from './store'
import App from './App'
ReactDOM.render(
<Provider store={store}>
<App />
</Provider>,
document.getElementById('root')
)
Competitor Comparisons
The library for web and native user interfaces.
Pros of React
- Broader scope: React is a complete UI library for building user interfaces, while Redux Toolkit is focused solely on state management
- Larger ecosystem: React has a vast ecosystem of tools, libraries, and community support
- More flexible: Can be used with various state management solutions, not limited to Redux
Cons of React
- Steeper learning curve: React's flexibility can make it more challenging for beginners compared to Redux Toolkit's opinionated approach
- Requires additional libraries: Often needs extra packages for routing, state management, etc., while Redux Toolkit provides a more complete solution for its specific use case
Code Comparison
React component:
function Counter() {
const [count, setCount] = useState(0);
return (
<button onClick={() => setCount(count + 1)}>
Count: {count}
</button>
);
}
Redux Toolkit slice:
const counterSlice = createSlice({
name: 'counter',
initialState: 0,
reducers: {
increment: state => state + 1
}
});
🗃️ Centralized State Management for Vue.js.
Pros of Vuex
- Simpler learning curve and easier setup for beginners
- Tighter integration with Vue.js ecosystem
- More compact and concise syntax for defining stores
Cons of Vuex
- Less flexibility for complex state management scenarios
- Fewer built-in utilities and helper functions
- Limited TypeScript support compared to Redux Toolkit
Code Comparison
Vuex store definition:
export default new Vuex.Store({
state: { count: 0 },
mutations: {
increment(state) { state.count++ }
}
})
Redux Toolkit store definition:
const counterSlice = createSlice({
name: 'counter',
initialState: { value: 0 },
reducers: {
increment: state => { state.value += 1 }
}
})
Both Redux Toolkit and Vuex are popular state management libraries for their respective frameworks. Redux Toolkit offers more robust features and better TypeScript support, making it suitable for larger, complex applications. Vuex, on the other hand, provides a simpler and more straightforward approach, making it ideal for smaller to medium-sized Vue.js projects. The choice between the two often depends on the specific needs of the project and the developer's familiarity with the respective ecosystems.
Simple, scalable state management.
Pros of MobX
- Simpler setup and less boilerplate code
- Automatic tracking of state changes and re-rendering
- More flexible and less opinionated about state structure
Cons of MobX
- Less predictable state updates due to mutable state
- Steeper learning curve for developers used to immutable state patterns
- Potential for performance issues with large, complex state trees
Code Comparison
MobX:
import { makeAutoObservable } from "mobx";
class TodoStore {
todos = [];
constructor() {
makeAutoObservable(this);
}
addTodo(text) {
this.todos.push({ text, completed: false });
}
}
Redux Toolkit:
import { createSlice } from "@reduxjs/toolkit";
const todosSlice = createSlice({
name: "todos",
initialState: [],
reducers: {
addTodo: (state, action) => {
state.push({ text: action.payload, completed: false });
},
},
});
Both MobX and Redux Toolkit are popular state management libraries for React applications. MobX offers a more straightforward approach with less boilerplate, while Redux Toolkit provides a more structured and predictable state management solution. The choice between them often depends on project requirements, team preferences, and scalability needs.
Reactive State for Angular
Pros of NgRx Platform
- Tightly integrated with Angular, providing a seamless experience for Angular developers
- Offers a comprehensive suite of tools beyond state management, including effects, entity management, and router integration
- Provides strong typing and compile-time checks, enhancing code reliability
Cons of NgRx Platform
- Steeper learning curve due to its complexity and Angular-specific concepts
- Can be overkill for smaller applications, potentially leading to unnecessary boilerplate
- Limited to Angular ecosystem, not suitable for other frameworks or vanilla JavaScript
Code Comparison
NgRx Platform:
@Component({...})
export class MyComponent {
data$ = this.store.select(selectData);
constructor(private store: Store) {}
loadData() {
this.store.dispatch(loadData());
}
}
Redux Toolkit:
const slice = createSlice({
name: 'data',
initialState: [],
reducers: {
loadData: (state, action) => {
// Update state
}
}
});
Both libraries aim to simplify state management, but NgRx Platform is specifically designed for Angular applications, while Redux Toolkit is more versatile and can be used with various JavaScript frameworks or vanilla JavaScript. NgRx Platform offers a more opinionated and Angular-centric approach, while Redux Toolkit provides a more flexible solution for state management across different environments.
The Redux Framework
Pros of Rematch
- Simpler API with less boilerplate code
- Built-in support for async actions without additional middleware
- Easier to scale and maintain large applications
Cons of Rematch
- Smaller community and ecosystem compared to Redux Toolkit
- Less flexibility in terms of customization and middleware integration
- Steeper learning curve for developers already familiar with Redux
Code Comparison
Redux Toolkit:
const counterSlice = createSlice({
name: 'counter',
initialState: 0,
reducers: {
increment: state => state + 1,
decrement: state => state - 1,
},
});
Rematch:
const counter = {
state: 0,
reducers: {
increment: state => state + 1,
decrement: state => state - 1,
},
};
Both Redux Toolkit and Rematch aim to simplify Redux development, but they take different approaches. Redux Toolkit provides a set of utilities to streamline Redux usage while maintaining its core principles. Rematch, on the other hand, offers a more opinionated structure that reduces boilerplate and simplifies state management.
Redux Toolkit is generally considered the official, recommended way to write Redux logic. It has a larger community, more extensive documentation, and better integration with the Redux ecosystem. Rematch, while powerful and efficient, may be a better choice for developers looking for a fresh approach to state management or those working on larger applications where Redux's verbosity becomes cumbersome.
Convert 
designs to code with AI
Introducing Visual Copilot: A new AI model to turn Figma designs to high quality code using your components.
Try Visual CopilotREADME
Redux Toolkit
The official, opinionated, batteries-included toolset for efficient Redux development
Installation
Create a React Redux App
The recommended way to start new apps with React and Redux Toolkit is by using our official Redux Toolkit + TS template for Vite, or by creating a new Next.js project using Next's with-redux template.
Both of these already have Redux Toolkit and React-Redux configured appropriately for that build tool, and come with a small example app that demonstrates how to use several of Redux Toolkit's features.
# Vite with our Redux+TS template
# (using the `degit` tool to clone and extract the template)
npx degit reduxjs/redux-templates/packages/vite-template-redux my-app
# Next.js using the `with-redux` template
npx create-next-app --example with-redux my-app
We do not currently have official React Native templates, but recommend these templates for standard React Native and for Expo:
- https://github.com/rahsheen/react-native-template-redux-typescript
- https://github.com/rahsheen/expo-template-redux-typescript
An Existing App
Redux Toolkit is available as a package on NPM for use with a module bundler or in a Node application:
# NPM
npm install @reduxjs/toolkit
# Yarn
yarn add @reduxjs/toolkit
The package includes a precompiled ESM build that can be used as a <script type="module"> tag directly in the browser.
Documentation
The Redux Toolkit docs are available at https://redux-toolkit.js.org, including API references and usage guides for all of the APIs included in Redux Toolkit.
The Redux core docs at https://redux.js.org includes the full Redux tutorials, as well usage guides on general Redux patterns.
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, 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 does not address concepts like "reusable encapsulated Redux modules", folder or file structures, managing entity relationships in the store, and so on.
Redux Toolkit also includes a powerful data fetching and caching capability that we've dubbed "RTK Query". It's included in the package as a separate set of entry points. It's optional, but can eliminate the need to hand-write data fetching logic yourself.
What's Included
Redux Toolkit includes these APIs:
configureStore(): wrapscreateStoreto provide simplified configuration options and good defaults. It can automatically combine your slice reducers, add whatever Redux middleware you supply, includesredux-thunkby default, and enables use of the Redux DevTools Extension.createReducer(): lets you supply a lookup table of action types to case reducer functions, rather than writing switch statements. In addition, it automatically uses theimmerlibrary 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(): combinescreateReducer()+createAction(). 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.combineSlices(): combines multiple slices into a single reducer, and allows "lazy loading" of slices after initialisation.createListenerMiddleware(): lets you define "listener" entries that contain an "effect" callback with additional logic, and a way to specify when that callback should run based on dispatched actions or state changes. A lightweight alternative to Redux async middleware like sagas and observables.createAsyncThunk(): accepts an action type string and a function that returns a promise, and generates a thunk that dispatchespending/resolved/rejectedaction types based on that promisecreateEntityAdapter(): generates a set of reusable reducers and selectors to manage normalized data in the store- The
createSelector()utility from the Reselect library, re-exported for ease of use.
For details, see the Redux Toolkit API Reference section in the docs.
RTK Query
RTK Query is provided as an optional addon within the @reduxjs/toolkit package. It is purpose-built to solve the use case of data fetching and caching, supplying a compact, but powerful toolset to define an API interface layer for your app. It is intended to simplify common cases for loading data in a web application, eliminating the need to hand-write data fetching & caching logic yourself.
RTK Query is built on top of the Redux Toolkit core for its implementation, using Redux internally for its architecture. Although knowledge of Redux and RTK are not required to use RTK Query, you should explore all of the additional global store management capabilities they provide, as well as installing the Redux DevTools browser extension, which works flawlessly with RTK Query to traverse and replay a timeline of your request & cache behavior.
RTK Query is included within the installation of the core Redux Toolkit package. It is available via either of the two entry points below:
import { createApi } from '@reduxjs/toolkit/query'
/* React-specific entry point that automatically generates
hooks corresponding to the defined endpoints */
import { createApi } from '@reduxjs/toolkit/query/react'
What's included
RTK Query includes these APIs:
createApi(): The core of RTK Query's functionality. It allows you to define a set of endpoints describe how to retrieve data from a series of endpoints, including configuration of how to fetch and transform that data. In most cases, you should use this once per app, with "one API slice per base URL" as a rule of thumb.fetchBaseQuery(): A small wrapper around fetch that aims to simplify requests. Intended as the recommended baseQuery to be used in createApi for the majority of users.<ApiProvider />: Can be used as a Provider if you do not already have a Redux store.setupListeners(): A utility used to enable refetchOnMount and refetchOnReconnect behaviors.
See the RTK Query Overview page for more details on what RTK Query is, what problems it solves, and how to use it.
Contributing
Please refer to our contributing guide to learn about our development process, how to propose bugfixes and improvements, and how to build and test your changes to Redux Toolkit.
Top Related Projects
Convert designs to code with AI
Introducing Visual Copilot: A new AI model to turn Figma designs to high quality code using your components.
Try Visual Copilot