Redux Toolkitでグローバルで状態管理できるLoadingを用意する

個人開発で Redux Toolkit を導入したのでそのメモ。

redux-toolkit.js.org

これまで Redux を使った開発経験はあるものの、直近だとあまり触る機会がありませんでした。
しばらく触らない期間があると実装についてど忘れしてしまい、その度にググって試行錯誤しちゃうので、今回はそうならないよう、シンプルに実装できる Loading の管理するコードを残し、未来の自分のための備忘録として残したいと思います。

Slice

まずは Action Creator、Reducer 関数をエクスポートするために loading 用の Slice を用意する。

// features/loading/loadingSlice.ts

import { createSlice } from "@reduxjs/toolkit";
import type { PayloadAction } from "@reduxjs/toolkit";

type LoadingState = {
  shown: boolean;
  message: string;
};

const initialState: LoadingState = {
  message: "",
  shown: false,
};

export const loadingSlice = createSlice({
  name: "loading",
  initialState,
  reducers: {
    setLoading: (state, action: PayloadAction<{ message: string }>) => {
      state.shown = true;
      state.message = action.payload.message;
    },
    resetLoading: (state) => {
      state.shown = false;
      state.message = "";
    },
  },
});

export const { setLoading, resetLoading } = loadingSlice.actions;
export default loadingSlice.reducer;

Store

reducer をまとめる store のコード。
Basic Reducer Structure | Redux を参考に ui に関する reducer をまとめる。

import { configureStore, combineReducers } from "@reduxjs/toolkit";
import loadingReducer from "@/features/loading/loadingSlice";

const store = configureStore({
  reducer: {
    ui: combineReducers({
      loading: loadingReducer,
    }),
  },
});

export type RootState = ReturnType<typeof store.getState>;

状態をコンポーネント間で管理できるように、store でラップするコード (Next.js 例)

import React from "react";
import { Provider } from "react-redux";
import { store } from "@/store";

function MyApp({ Component, pageProps }) {
  return (
    <Provider store={store}>
      <Component {...pageProps} />
    </Provider>
  );
}

Component

Loading のコンポーネント。(TailwindCSS を利用した例).

Tailwind CSS Spinner - Flowbite

// features/loading/Loading.tsx

import React from "react";
import { useSelector } from "react-redux";
import type { RootState } from "../../pages/_app";

const Loading = () => {
  const { shown, message } = useSelector((state: RootState) => state.ui.loading);

  if (!shown) {
    return <></>;
  }

  return (
    <div role="status">
      <svg aria-hidden="true" className="mr-2 w-8 h-8 text-gray-200 animate-spin dark:text-gray-600 fill-blue-600" viewBox="0 0 100 101" fill="none" xmlns="http://www.w3.org/2000/svg">
        <path d="M100 50.5908C100 78.2051 77.6142 100.591 50 100.591C22.3858 100.591 0 78.2051 0 50.5908C0 22.9766 22.3858 0.59082 50 0.59082C77.6142 0.59082 100 22.9766 100 50.5908ZM9.08144 50.5908C9.08144 73.1895 27.4013 91.5094 50 91.5094C72.5987 91.5094 90.9186 73.1895 90.9186 50.5908C90.9186 27.9921 72.5987 9.67226 50 9.67226C27.4013 9.67226 9.08144 27.9921 9.08144 50.5908Z" fill="currentColor"/>
        <path d="M93.9676 39.0409C96.393 38.4038 97.8624 35.9116 97.0079 33.5539C95.2932 28.8227 92.871 24.3692 89.8167 20.348C85.8452 15.1192 80.8826 10.7238 75.2124 7.41289C69.5422 4.10194 63.2754 1.94025 56.7698 1.05124C51.7666 0.367541 46.6976 0.446843 41.7345 1.27873C39.2613 1.69328 37.813 4.19778 38.4501 6.62326C39.0873 9.04874 41.5694 10.4717 44.0505 10.1071C47.8511 9.54855 51.7191 9.52689 55.5402 10.0491C60.8642 10.7766 65.9928 12.5457 70.6331 15.2552C75.2735 17.9648 79.3347 21.5619 82.5849 25.841C84.9175 28.9121 86.7997 32.2913 88.1811 35.8758C89.083 38.2158 91.5421 39.6781 93.9676 39.0409Z" fill="currentFill"/>
      </svg>
      <span className="sr-only">{message}</span>
    </div>
  );
};

export default Loading;

各コンポーネントで表示制御できるように、コードを追加 (Next.js 例)

import Loading from "@/features/loading/Loading";

function MyApp({ Component, pageProps }: any) {
  return (
    <Provider store={store}>
      <Component {...pageProps} />

      <Loading />
    </Provider>
  );
}

実際に Loading を表示制御を行う呼び出し元コンポーネントからは dispatch で呼び出す。

import React, { useEffect } from "react";
import { useDispatch } from "react-redux";
import { setLoading, resetLoading } from "@/features/loading/loadingSlice";

// 省略
const MyComponent = (props: { text: string }) => {
  const dispatch = useDispatch();

  useEffect(() => {
    // Loading を表示
    dispatch(setLoading({ message: "読み込んでいます。" }));

    setTimeout(() => {  // 何か処理がある想定
      // Loading を非表示
      dispatch(resetLoading());
    }, 1000);
  }, []);

  return <h1>Hello MyComponent !</h1>;
};

export default MyComponent;

以上

これだけでグローバルで状態管理できる Loading を用意できます。
Redux Toolkit を使うとコアになるコードを Slice にまとめられるのでコードの見通しが良くなります。

このシンプルな実装でも応用も効きやすく、よく使えそうな事例だと思うので、今後も Redux Toolkit を使うタイミングで見返したいと思います。

以上です。