Gathering detailed insights and metrics for @reduxjs/toolkit
Gathering detailed insights and metrics for @reduxjs/toolkit
Gathering detailed insights and metrics for @reduxjs/toolkit
Gathering detailed insights and metrics for @reduxjs/toolkit
reduxjs-toolkit-persist
persist and rehydrate redux stores
@didley/reduxjs-toolkit
Extends redux-toolkit's createEntityAdapter with some additional utils
@carlhopf/reduxjs-toolkit
webpack re-packaged @reduxjs/toolkit
@adamldoyle/reduxjs-toolkit-monitored-slice
Allow easy creation of a monitored slice that's compatible with @reduxjs/toolkit. A monitored slice automatically manages the lifecycle of provided data by tracking when it's stale, when it's loading, or when it's available.
The official, opinionated, batteries-included toolset for efficient Redux development
npm install @reduxjs/toolkit
Typescript
Module System
Node Version
NPM Version
v2.5.0
Published on 11 Dec 2024
v2.4.0
Published on 28 Nov 2024
v2.3.0
Published on 14 Oct 2024
RTK-Query OpenAPI Codegen v2.0.0
Published on 14 Oct 2024
v2.2.8
Published on 08 Oct 2024
RTK-Query OpenAPI Codegen v1.2.0
Published on 30 Aug 2024
TypeScript (96.51%)
JavaScript (2.96%)
CSS (0.52%)
Total Downloads
432,504,014
Last Day
794,976
Last Week
4,048,863
Last Month
17,095,951
Last Year
174,186,729
10,778 Stars
4,189 Commits
1,183 Forks
72 Watching
102 Branches
378 Contributors
Minified
Minified + Gzipped
Latest Version
2.5.0
Package Id
@reduxjs/toolkit@2.5.0
Unpacked Size
5.35 MB
Size
1.16 MB
File Count
236
NPM Version
9.8.1
Node Version
18.18.2
Publised On
11 Dec 2024
Cumulative downloads
Total Downloads
Last day
1.3%
794,976
Compared to previous day
Last week
9%
4,048,863
Compared to previous week
Last month
10.5%
17,095,951
Compared to previous month
Last year
34.6%
174,186,729
Compared to previous year
4
2
52
The official, opinionated, batteries-included toolset for efficient Redux development
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.
1# Vite with our Redux+TS template 2# (using the `degit` tool to clone and extract the template) 3npx degit reduxjs/redux-templates/packages/vite-template-redux my-app 4 5# Next.js using the `with-redux` template 6npx 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:
Redux Toolkit is available as a package on NPM for use with a module bundler or in a Node application:
1# NPM 2npm install @reduxjs/toolkit 3 4# Yarn 5yarn add @reduxjs/toolkit
The package includes a precompiled ESM build that can be used as a <script type="module">
tag directly in the browser.
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.
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:
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.
Redux Toolkit includes these APIs:
configureStore()
: wraps createStore
to provide simplified configuration options and good defaults. It can automatically combine your slice reducers, add whatever Redux middleware you supply, includes redux-thunk
by 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 the immer
library to let you write simpler immutable updates with normal mutative code, like state.todos[3].completed = true
.createAction()
: generates 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.createSlice()
: combines createReducer()
+ 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 dispatches pending/resolved/rejected
action types based on that promisecreateEntityAdapter()
: generates a set of reusable reducers and selectors to manage normalized data in the storecreateSelector()
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 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:
1import { createApi } from '@reduxjs/toolkit/query' 2 3/* React-specific entry point that automatically generates 4 hooks corresponding to the defined endpoints */ 5import { createApi } from '@reduxjs/toolkit/query/react'
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.
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.
No vulnerabilities found.
Reason
30 commit(s) and 19 issue activity found in the last 90 days -- score normalized to 10
Reason
no dangerous workflow patterns detected
Reason
license file detected
Details
Reason
packaging workflow detected
Details
Reason
binaries present in source code
Details
Reason
Found 7/11 approved changesets -- score normalized to 6
Reason
security policy file not detected
Details
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
detected GitHub workflow tokens with excessive permissions
Details
Reason
dependency not pinned by hash detected -- score normalized to 0
Details
Reason
project is not fuzzed
Details
Reason
branch protection not enabled on development/release branches
Details
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
Reason
97 existing vulnerabilities detected
Details
Score
Last Scanned on 2024-11-25
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More