React redux typescript tutorial

Usage with TypeScript

As of React-Redux v8, React-Redux is fully written in TypeScript, and the types are included in the published package. The types also export some helpers to make it easier to write typesafe interfaces between your Redux store and your React components.

The recently updated @types/react@18 major version has changed component definitions to remove having children as a prop by default. This causes errors if you have multiple copies of @types/react in your project. To fix this, tell your package manager to resolve @types/react to a single version. Details:

Standard Redux Toolkit Project Setup with TypeScript​

We assume that a typical Redux project is using Redux Toolkit and React Redux together.

Redux Toolkit (RTK) is the standard approach for writing modern Redux logic. RTK is already written in TypeScript, and its API is designed to provide a good experience for TypeScript usage.

The Redux+TS template for Create-React-App comes with a working example of these patterns already configured.

Define Root State and Dispatch Types​

Using configureStore should not need any additional typings. You will, however, want to extract the RootState type and the Dispatch type so that they can be referenced as needed. Inferring these types from the store itself means that they correctly update as you add more state slices or modify middleware settings.

Since those are types, it’s safe to export them directly from your store setup file such as app/store.ts and import them directly into other files.

import  configureStore > from '@reduxjs/toolkit' // .  const store = configureStore(  reducer:   posts: postsReducer,  comments: commentsReducer,  users: usersReducer, >, >)  // Infer the `RootState` and `AppDispatch` types from the store itself export type RootState = ReturnTypetypeof store.getState> // Inferred type: export type AppDispatch = typeof store.dispatch 

Define Typed Hooks​

While it’s possible to import the RootState and AppDispatch types into each component, it’s better to create pre-typed versions of the useDispatch and useSelector hooks for usage in your application. This is important for a couple reasons:

• For useSelector , it saves you the need to type (state: RootState) every time
• For useDispatch , the default Dispatch type does not know about thunks or other middleware. In order to correctly dispatch thunks, you need to use the specific customized AppDispatch type from the store that includes the thunk middleware types, and use that with useDispatch . Adding a pre-typed useDispatch hook keeps you from forgetting to import AppDispatch where it’s needed.

Since these are actual variables, not types, it’s important to define them in a separate file such as app/hooks.ts , not the store setup file. This allows you to import them into any component file that needs to use the hooks, and avoids potential circular import dependency issues.

import  TypedUseSelectorHook, useDispatch, useSelector > from 'react-redux' import type  RootState, AppDispatch > from './store'  // Use throughout your app instead of plain `useDispatch` and `useSelector` export const useAppDispatch: () => AppDispatch = useDispatch export const useAppSelector: TypedUseSelectorHookRootState> = useSelector 

Typing Hooks Manually​

We recommend using the pre-typed useAppSelector and useAppDispatch hooks shown above. If you prefer not to use those, here is how to type the hooks by themselves.

Typing the useSelector hook​

When writing selector functions for use with useSelector , you should explicitly define the type of the state parameter. TS should be able to then infer the return type of the selector, which will be reused as the return type of the useSelector hook:

interface RootState   isOn: boolean >  // TS infers type: (state: RootState) => boolean const selectIsOn = (state: RootState) => state.isOn  // TS infers `isOn` is boolean const isOn = useSelector(selectIsOn) 

This can also be done inline as well:

const isOn = useSelector((state: RootState) => state.isOn) 

Typing the useDispatch hook​

By default, the return value of useDispatch is the standard Dispatch type defined by the Redux core types, so no declarations are needed:

const dispatch = useDispatch() 

If you have a customized version of the Dispatch type, you may use that type explicitly:

// store.ts export type AppDispatch = typeof store.dispatch  // MyComponent.tsx const dispatch: AppDispatch = useDispatch() 

Typing the connect higher order component​

Inferring The Connected Props Automatically​

connect consists of two functions that are called sequentially. The first function accepts mapState and mapDispatch as arguments, and returns a second function. The second function accepts the component to be wrapped, and returns a new wrapper component that passes down the props from mapState and mapDispatch . Normally, both functions are called together, like connect(mapState, mapDispatch)(MyComponent) .

The package includes a helper type, ConnectedProps , that can extract the return types of mapStateToProps and mapDispatchToProps from the first function. This means that if you split the connect call into two steps, all of the «props from Redux» can be inferred automatically without having to write them by hand. While this approach may feel unusual if you’ve been using React-Redux for a while, it does simplify the type declarations considerably.

import  connect, ConnectedProps > from 'react-redux'  interface RootState   isOn: boolean >  const mapState = (state: RootState) => (  isOn: state.isOn, >)  const mapDispatch =   toggleOn: () => ( type: 'TOGGLE_IS_ON' >), >  const connector = connect(mapState, mapDispatch)  // The inferred type will look like: // void> type PropsFromRedux = ConnectedPropstypeof connector> 

The return type of ConnectedProps can then be used to type your props object.

interface Props extends PropsFromRedux   backgroundColor: string >  const MyComponent = (props: Props) => ( div style= backgroundColor: props.backgroundColor >>> button onClick=props.toggleOn>>  Toggle is props.isOn ? 'ON' : 'OFF'> button> div> )  export default connector(MyComponent) 

Because types can be defined in any order, you can still declare your component before declaring the connector if you want.

// alternately, declare `type Props = PropsFromRedux & ` interface Props extends PropsFromRedux   backgroundColor: string; >  const MyComponent = (props: Props) => /* same as above */  const connector = connect(/* same as above*/)  type PropsFromRedux = ConnectedPropstypeof connector>  export default connector(MyComponent) 

Manually Typing connect ​

The connect higher-order component is somewhat complex to type, because there are 3 sources of props: mapStateToProps , mapDispatchToProps , and props passed in from the parent component. Here’s a full example of what it looks like to do that manually.

import  connect > from 'react-redux'  interface StateProps   isOn: boolean >  interface DispatchProps   toggleOn: () => void >  interface OwnProps   backgroundColor: string >  type Props = StateProps & DispatchProps & OwnProps  const mapState = (state: RootState) => (  isOn: state.isOn, >)  const mapDispatch =   toggleOn: () => ( type: 'TOGGLE_IS_ON' >), >  const MyComponent = (props: Props) => ( div style= backgroundColor: props.backgroundColor >>> button onClick=props.toggleOn>>  Toggle is props.isOn ? 'ON' : 'OFF'> button> div> )  // Typical usage: `connect` is called after the component is defined export default connectStateProps, DispatchProps, OwnProps>(  mapState,  mapDispatch )(MyComponent) 

It is also possible to shorten this somewhat, by inferring the types of mapState and mapDispatch :

const mapState = (state: RootState) => (  isOn: state.isOn, >)  const mapDispatch =   toggleOn: () => ( type: 'TOGGLE_IS_ON' >), >  type StateProps = ReturnTypetypeof mapState> type DispatchProps = typeof mapDispatch  type Props = StateProps & DispatchProps & OwnProps 

However, inferring the type of mapDispatch this way will break if it is defined as an object and also refers to thunks.

Recommendations​

The hooks API is generally simpler to use with static types. If you’re looking for the easiest solution for using static types with React-Redux, use the hooks API.

If you’re using connect , we recommend using the ConnectedProps approach for inferring the props from Redux, as that requires the fewest explicit type declarations.

Resources​

For additional information, see these additional resources:

• Redux docs: Usage with TypeScript: Examples of how to use Redux Toolkit, the Redux core, and React Redux with TypeScript
• Redux Toolkit docs: TypeScript Quick start: shows how to use RTK and the React-Redux hooks API with TypeScript
• React+TypeScript Cheatsheet: a comprehensive guide to using React with TypeScript
• React + Redux in TypeScript Guide: extensive information on patterns for using React and Redux with TypeScript

Источник