Skip to main content

Vue Redux Quick Start

What You'll Learn
  • How to set up and use Redux Toolkit with Vue Redux
Prerequisites

Introduction​

Welcome to the Vue Redux Quick Start tutorial! This tutorial will briefly introduce you to Vue Redux and teach you how to start using it correctly.

How to Read This Tutorial​

This page will focus on just how to set up a Redux application with Redux Toolkit and the main APIs you'll use. For explanations of what Redux is, how it works, and full examples of how to use Redux Toolkit, see the Redux core docs tutorials.

For this tutorial, we assume that you're using Redux Toolkit and Vue Redux together, as that is the standard Redux usage pattern. The examples are based on a typical Vite Vue CLI folder structure where all the application code is in a src, but the patterns can be adapted to whatever project or folder setup you're using.

Usage Summary​

Install Redux Toolkit and Vue Redux​

Add the Redux Toolkit and Vue Redux packages to your project:

npm install @reduxjs/toolkit @reduxjs/vue-redux

Create a Redux Store​

Create a file named src/app/store.ts. Import the configureStore API from Redux Toolkit. We'll start by creating an empty Redux store, and exporting it:

app/store.ts
import { configureStore } from "@reduxjs/toolkit";

export default configureStore({
  reducer: {},
});

This creates a Redux store, and also automatically configure the Redux DevTools extension so that you can inspect the store while developing.

Provide the Redux Store to Vue​

Once the store is created, we can make it available to our Vue components by putting an Vue Redux provideStoreToApp function call to wrap our createApp instance in src/main.ts. Import the Redux store we just created, put a provideStoreToApp call around your createApp instance, and pass the store as a prop:

main.ts
import { createApp } from 'vue'
import App from './App.vue'
import { provideStoreToApp } from '@reduxjs/vue-redux'
import { store } from './store'

const app = createApp(App)
provideStoreToApp(app, { store })
app.mount('#app')

Create a Redux State Slice​

Add a new file named src/features/counter/counter-slice.ts. In that file, import the createSlice API from Redux Toolkit.

Creating a slice requires a string name to identify the slice, an initial state value, and one or more reducer functions to define how the state can be updated. Once a slice is created, we can export the generated Redux action creators and the reducer function for the whole slice.

Redux requires that we write all state updates immutably, by making copies of data and updating the copies. However, Redux Toolkit's createSlice and createReducer APIs use Immer inside to allow us to write "mutating" update logic that becomes correct immutable updates.

features/counter/counter-slice.ts
import { createSlice } from "@reduxjs/toolkit";

export const counterSlice = createSlice({
  name: "counter",
  initialState: {
    value: 0,
  },
  reducers: {
    increment: (state) => {
      // Redux Toolkit allows us to write "mutating" logic in reducers. It
      // doesn't actually mutate the state because it uses the Immer library,
      // which detects changes to a "draft state" and produces a brand new
      // immutable state based off those changes.
      // Also, no return statement is required from these functions.
      state.value += 1;
    },
    decrement: (state) => {
      state.value -= 1;
    },
    incrementByAmount: (state, action) => {
      state.value += action.payload;
    },
  },
});

// Action creators are generated for each case reducer function
export const { increment, decrement, incrementByAmount } = counterSlice.actions;

export default counterSlice.reducer;

Add Slice Reducers to the Store​

Next, we need to import the reducer function from the counter slice and add it to our store. By defining a field inside the reducer parameter, we tell the store to use this slice reducer function to handle all updates to that state.

app/store.ts
import { configureStore } from '@reduxjs/toolkit'
import counterReducer from './features/counter/counterSlice'

export default configureStore({
  reducer: {
    counter: counterReducer,
  },
})

Use Redux State and Actions in Vue Components​

Now we can use the Vue Redux compositions to let Vue components interact with the Redux store. We can read data from the store with useSelector, and dispatch actions using useDispatch. Create a src/features/counter/counter.component.ts file with a <Counter> component inside, then import that component into App.vue and render it inside of <App>.

features/counter/Counter.vue
<script setup>
  import { useSelector, useDispatch } from '@reduxjs/vue-redux'
  import { decrement, increment } from './counter-slice'

  const count = useSelector((state) => state.counter.value)
  const dispatch = useDispatch()
</script>

<template>
  <div>
    <div>
      <button aria-label="Increment value" @click="dispatch(increment())">
        Increment
      </button>
      <span>{{ count }}</span>
      <button aria-label="Decrement value" @click="dispatch(decrement())">
        Decrement
      </button>
    </div>
  </div>
</template>

Now, any time you click the "Increment" and "Decrement buttons:

  • The corresponding Redux action will be dispatched to the store
  • The counter slice reducer will see the actions and update its state
  • The <Counter> component will see the new state value from the store and re-render itself with the new data

What You've Learned​

That was a brief overview of how to set up and use Redux Toolkit with Vue. Recapping the details:

Summary
  • Create a Redux store with configureStore
    • configureStore accepts a reducer function as a named argument
    • configureStore automatically sets up the store with good default settings
  • Provide the Redux store to the Vue application components
    • Put a Vue Redux provideStoreToApp function to wrap your createApp's instance
  • Create a Redux "slice" reducer with createSlice
    • Call createSlice with a string name, an initial state, and named reducer functions
    • Reducer functions may "mutate" the state using Immer
    • Export the generated slice reducer and action creators
  • Use the Vue Redux useSelector/useDispatch compositions in Vue components
    • Read data from the store with the useSelector composition
    • Get the dispatch function with the useDispatch composition, and dispatch actions as needed

Full Counter App Example​

Here's the complete Counter application as a running StackBlitz:

What's Next?​

We recommend going through the "Redux Essentials" and "Redux Fundamentals" tutorials in the Redux core docs, which will give you a complete understanding of how Redux works, what Redux Toolkit and Vue Redux do, and how to use it correctly.