ブログ

TypeScriptでReact Nativeのナビゲーションを構成する方法

2022年9月24日 8分で読めます

TypeScriptでReact Navigation v6を使いこなす。React Nativeアプリケーションでの型安全なナビゲーション、パラメータの受け渡し、高度なナビゲーションのパターンを学びます。

TypeScriptでReact Nativeのナビゲーションを構成する方法
React NativeTypeScriptナビゲーションReact Navigation

型を活用する: React Navigation

ナビゲーションの構築は、今やあらゆるモバイルアプリケーションの基本的な機能です。React Nativeの世界では、React Navigationという頼れる道具があります。

この記事では、TypeScriptを使った典型的なReact Navigationの実装方法を、TypeScriptの使い方のさまざまな戦略を比較しながら見ていきます。

そしてもっと大事なこととして、TypeScriptの機能を最大限に活用して、よりスケーラブルなナビゲーションのアーキテクチャを作る方法も扱います。

注意: この記事の例は、@react-navigation@6.xのバージョンを使って作成しています。

注意: この記事で扱う方法や戦略は、厳密に従わなければならない必須のものではありません。あくまで私の好みであり、この記事の読者と共有する価値があると感じたものです。React Navigationには、TypeScriptの使い方について、すでに素晴らしくよく書かれたドキュメントがあります。 とはいえ、このドキュメントに従うだけでも、素晴らしいreact-navigationのTypeScriptの構成を作れます。

Stack Navigatorを作る

React Navigation パッケージを使ってstack navigatorを作る方法を見てみましょう。

React Navigationから引用した次の例を見てください。

import { createStackNavigator } from "@react-navigation/stack";
import * as React from "react";
import { View } from "react-native";

const Stack = createStackNavigator();

const Home = () => <View />;
const Notifications = () => <View />;
const Profile = () => <View />;
const Settings = () => <View />;

function AppStack() {
  return (
    <Stack.Navigator>
      <Stack.Screen name="Home" component={Home} />
      <Stack.Screen name="Notifications" component={Notifications} />
      <Stack.Screen name="Profile" component={Profile} />
      <Stack.Screen name="Settings" component={Settings} />
    </Stack.Navigator>
  );
}

見てのとおり、ここにはTypeScript特有のものは何もないので、このコードスニペットに少しTypeScriptを加えてみましょう。

import { createStackNavigator } from "@react-navigation/stack";
import * as React from "react";
import { View } from "react-native";

type AppStackParamList = {
  Home: undefined;
  Notifications: undefined;
  Profile: undefined;
  Settings: undefined;
};

const Home = () => <View />;
const Notifications = () => <View />;
const Profile = () => <View />;
const Settings = () => <View />;

const Stack = createStackNavigator<AppStackParamList>();

function AppStack() {
  return (
    <Stack.Navigator>
      <Stack.Screen name="Home" component={Home} />
      <Stack.Screen name="Notifications" component={Notifications} />
      <Stack.Screen name="Profile" component={Profile} />
      <Stack.Screen name="Settings" component={Settings} />
    </Stack.Navigator>
  );
}

上では、createStackNavigatorにParamListの型を追加しました。でも、createStackNavigatorがジェネリック型を受け取ることを、どうやって知ればいいのでしょうか? 調べる方法はいくつかあります。まずドキュメントを確認するのは、いつだって良い習慣です。この例では、ドキュメントにすでにそのためのセクションがあることに気づくはずです。

一方、createStackNavigatorのこの型付けがウェブサイトに書かれていないとしたら、関数に型があるかどうかを確かめる方法のひとつは、その関数の型定義にジャンプすることです。最初はたくさんの型、インターフェース、ジェネリクスが飛び交っていて圧倒されるかもしれませんが、型定義にジャンプする習慣がつくほど、ずっと気にならなくなります。

アップデート!

TypeScriptでさらに複雑なことに取り組みたい、そしてReactチームの素晴らしいTSユーティリティ(React.ComponentProps)をあえて使わないという人は、この記事の最後まで読み進めてください。

でも残念ながら、このセクションが終わりになるかもしれません!

React.ComponentPropsを使えば、各stackの画面とその設定の型を取得できます。結果は本当に素晴らしいものになります。

完全な例は次のとおりです。

import { createStackNavigator } from "@react-navigation/stack";
import * as React from "react";
import { View } from "react-native";

type AppStackParamList = {
  Home: undefined;
  Notifications: undefined;
  Profile: undefined;
  Settings: undefined;
};

const Home = () => <View />;
const Notifications = () => <View />;
const Profile = () => <View />;
const Settings = () => <View />;

const Stack = createStackNavigator<AppStackParamList>();

const routes: Array<React.ComponentProps<typeof Stack.Screen>> = [
  {
    name: "Home",
    component: Home,
  },
  {
    name: "Notifications",
    component: Notifications,
  },
  {
    name: "Profile",
    component: Profile,
  },
  {
    name: "Settings",
    component: Settings,
  },
];

function AppStack() {
  return (
    <Stack.Navigator>
      {routes.map((routeConfig) => (
        <Stack.Screen key={routeConfig.name} {...routeConfig} />
      ))}
    </Stack.Navigator>
  );
}

そしてもちろん、インテリセンスも効きますし、関係のない画面*(たとえば、stackの型宣言にない画面)*をstackに入れると、次のようにちゃんと警告してくれます。

無効な画面無効な画面

インテリセンスもちゃんと効きます。

さらに、よりきれいで、設定しやすく、動的です。

const getAuthStackRoutes = (
  // other parameters...
  theme: ThemeType
): Array<React.ComponentProps<typeof Stack.Screen>> => {
  // more business logic...

  return [
    {
      name: "Home",
      component: Home,
      options: {
        headerStyle: {
          backgroundColor: theme.colors.primary,
          // other theme stylings...
        },
      },
    },
  ];
};

結論として、このアプローチを使うと、複雑なナビゲーションの構成を簡単に管理できます*(少なくとも、この記事のほかのアプローチと比べた場合には)*。JSXがきれいになるだけでなく、ルートをより動的でモジュール化された方法で設定できるようになるからです。

TypeScriptの使い方をさらに一歩進める

できることは、createStackNavigatorのジェネリック型を宣言することだけではありません。Stack.Navigatorが持つ子要素の型はどうでしょうか? この考え方は公式ドキュメントですでにかなりよく説明されていますが、構成をより疎結合に作るために、これをどう活用できるかを見てみましょう。

import type { RouteConfig, StackNavigationState } from "@react-navigation/core";
import {
  createStackNavigator,
  StackNavigationEventMap,
  StackNavigationOptions,
} from "@react-navigation/stack";
import * as React from "react";
import { View } from "react-native";

// stack param list type
type AppStackParamList = {
  Home: undefined;
  Notifications: undefined;
  Profile: undefined;
  Settings: undefined;
};

// type of the single route in app stack
type AppStackRoutesType = RouteConfig<
  AppStackParamList,
  keyof AppStackParamList,
  StackNavigationState<AppStackParamList>,
  StackNavigationOptions,
  StackNavigationEventMap
>;

// mocking the screen components for the sake of example
const Home = () => <View />;
const Notifications = () => <View />;
const Profile = () => <View />;
const Settings = () => <View />;

// strictly typed array of app stack routes
const appStackRoutes: Array<AppStackRoutesType> = [
  {
    name: "Home",
    component: Home,
  },
  {
    name: "Notifications",
    component: Notifications,
  },
  {
    name: "Profile",
    component: Profile,
  },
  {
    name: "Settings",
    component: Settings,
  },
];

const Stack = createStackNavigator<AppStackParamList>();

function AppStack() {
  return (
    <Stack.Navigator>
      {/** mapping the app stack routes */}
      {appStackRoutes.map((stackRoute) => (
        <Stack.Screen key={stackRoute.name} {...stackRoute} />
      ))}
    </Stack.Navigator>
  );
}

おっと、いろいろなことが起きていますね… 各コードブロックを別々の部分に分けてみましょう。

import type { RouteConfig, StackNavigationState } from "@react-navigation/core";
import {
  createStackNavigator,
  StackNavigationEventMap,
  StackNavigationOptions,
} from "@react-navigation/stack";
import * as React from "react";
import { View } from "react-native";

コードスニペットの冒頭では、必要なモジュールをimportしています。型、関数、そのほか必要なものです。面白くはありませんが、必要です :)

// mocking the screen components for the sake of example
const Home = () => <View />;
const Notifications = () => <View />;
const Profile = () => <View />;
const Settings = () => <View />;

上では、例をよりシンプルに示せるように、react-nativeからViewコンポーネントをimportしています。

// type of the single route in app stack
type AppStackRoutesType = RouteConfig<
  AppStackParamList,
  keyof AppStackParamList,
  StackNavigationState<AppStackParamList>,
  StackNavigationOptions,
  StackNavigationEventMap
>;

さあ、ここからが面白いところです。@react-navigation/coreからimportしているRouteConfigは、ジェネリック型としてちょうど5つの型を受け取ります。この型定義は公式のreact-navigationのウェブサイトには書かれていませんが、上で触れた型定義にジャンプする方法を使えば、すぐに突き止められます。

典型的なreact-nativeのTypeScriptのプロジェクトでは冗長、あるいは不要に見えるかもしれませんが、いくつかの利点があり、それを次のセクションで扱います。

IntelliSense

stackのルート(つまりアプリのルート)の配列に厳密に型を付けたので、配列のすべての要素は配列の型定義に従わなければならなくなりました。つまり、配列に新しい要素を追加するとき、IntelliSenseが最初から効くということです。

さらに、この型を適用すると、アプリのルートに新しい要素を追加するたびに、AppStackRoutesType* を更新することが強制されます。そうしないと、AppStackRoutesType(AppStackParamList)に存在しない新しい要素は追加できません。*

ルートをマッピングする

いよいよ最後の部分です。createStackNavigatorを使ってstack navigatorを作ります。あとは、上で作った配列を、その厳密な型とともにマッピングするだけです。

最終的には配列のすべての要素を信頼できます。どの要素も正しく型付けされているので、スプレッド構文を安全に使えます。

const Stack = createStackNavigator<AppStackParamList>();

function AppStack() {
  return (
    <Stack.Navigator>
      {/** mapping the app stack routes */}
      {appStackRoutes.map((stackRoute) => (
        <Stack.Screen key={stackRoute.name} {...stackRoute} />
      ))}
    </Stack.Navigator>
  );
}

本当に最後の部分だった?

いえ… 違います!

ここまで扱った例の型付けは、まだ改善できます。

// generic stack routes type
export type StackRoutesType<ParamList extends ParamListBase> = Array<
  RouteConfig<
    ParamList,
    keyof ParamList,
    StackNavigationState<ParamList>,
    StackNavigationOptions,
    StackNavigationEventMap
  >
>;

type AppStackRoutesType = StackRoutesType<AppStackParamList>;

// mocking the screen components for the sake of example
const Home = () => <View />;
const Notifications = () => <View />;
const Profile = () => <View />;
const Settings = () => <View />;

// strictly typed array of app stack routes
const appStackRoutes: AppStackRoutesType = [
  {
    name: "Home",
    component: Home,
  },
  {
    name: "Notifications",
    component: Notifications,
  },
  {
    name: "Profile",
    component: Profile,
  },
  {
    name: "Settings",
    component: Settings,
  },
];

気づいたかもしれない違いは、ジェネリック型を受け取り、以前に見た型と同じになるStackRoutesTypeがあることです。でも、ここでの利点は何なのかと思うかもしれません。この問いには、目に見える形で答えるのが一番です。

// too much duplicated code...

type AppStackRoutesType = RouteConfig<
  AppStackParamList,
  keyof AppStackParamList,
  StackNavigationState<AppStackParamList>,
  StackNavigationOptions,
  StackNavigationEventMap
>;

type OtherStackRoutesType = RouteConfig<
  OtherStackParamList,
  keyof OtherStackParamList,
  StackNavigationState<OtherStackParamList>,
  StackNavigationOptions,
  StackNavigationEventMap
>;

type AnotherStackRoutesType = RouteConfig<
  AnotherStackParamList,
  keyof AnotherStackParamList,
  StackNavigationState<AnotherStackParamList>,
  StackNavigationOptions,
  StackNavigationEventMap
>;

ジェネリックなStackRoutesType*を使わなかったとしたら、*アプリにあるすべてのstackについて型を重複して書かなければなりません。

そうなると、アプリが大きくなるにつれて悪夢になります。(ここでの考え方は、アプリのstackの数とアプリの複雑さは正比例するというものです。実際には常に100%正しい前提ではありませんが、この例には当てはまります)

// generic stack routes type
export type StackRoutesType<ParamList extends ParamListBase> = Array<
  RouteConfig<
    ParamList,
    keyof ParamList,
    StackNavigationState<ParamList>,
    StackNavigationOptions,
    StackNavigationEventMap
  >
>;

// becomes one line typings for each stack
type AppStackRoutesType = StackRoutesType<AppStackParamList>;
type OtherStackRoutesType = StackRoutesType<OtherStackParamList>;
type AnotherStackRoutesType = StackRoutesType<AnotherStackParamList>;

一方、ジェネリック型を使うと、上のようにずっとシンプルできれいになるのがわかります。

最終的な姿

典型的なStackの関数が、2つの異なるシナリオでどう見えるかを比べてみましょう。

図1: JSXの中でstackのすべての画面をひとつずつ描画する。

// ...imports, components

function AppStack() {
  return (
    <Stack.Navigator>
      <Stack.Screen name="Home" component={Home} />
      <Stack.Screen name="Notifications" component={Notifications} />
      <Stack.Screen name="Profile" component={Profile} />
      <Stack.Screen name="Settings" component={Settings} />
      {/** n more screens... */}
    </Stack.Navigator>
  );
}

図2: 厳密に型付けしたTypeScriptで作ったstackのルートの配列を使って画面を描画する。 🎉

function AppStack() {
  return (
    <Stack.Navigator>
      {appStackRoutes.map((stackRoute) => (
        <Stack.Screen key={stackRoute.name} {...stackRoute} />
      ))}
    </Stack.Navigator>
  );
}

もうひとつ… Navigatorのpropsはどうする?

考えるべきことがもうひとつ残っているかもしれません。stack navigatorのpropsです。下のStackNavigator*を見ると、*ひとつのnavigatorに対して設定のかたまりがあります。これらの設定もJSXから切り離してしまいませんか?

import type {
  DefaultNavigatorOptions,
  ParamListBase,
  StackNavigationState,
} from "@react-navigation/core";
import {
  StackNavigationEventMap,
  StackNavigationOptions,
} from "@react-navigation/stack";
// other necessary imports for screens...

// generic typing for stack navigator options
type StackNavigatorOptions<ParamList extends ParamListBase> =
  DefaultNavigatorOptions<
    ParamList,
    StackNavigationState<ParamList>,
    StackNavigationOptions,
    StackNavigationEventMap
  >;

// omit the children as it corresponds to stack screen
const appStackNavigatorProps: Omit<
  StackNavigatorOptions<AppStackParamList>,
  "children"
> = {
  initialRouteName: "Home",
  screenOptions: {
    headerShown: false,
    cardOverlayEnabled: true,
    gestureEnabled: false,
    cardStyle: {
      backgroundColor: "royalblue",
    },
    headerLeftContainerStyle: {
      backgroundColor: "firebrick",
    },
    presentation: "modal",
    headerTitleStyle: {
      fontSize: 24,
      color: "olivedrab",
    },
  },
  // ...rest
};

// screen components and stack routes...

function AppStack() {
  return (
    <Stack.Navigator {...appStackNavigatorProps}>
      {appStackRoutes.map((stackRoute) => (
        <Stack.Screen key={stackRoute.name} {...stackRoute} />
      ))}
    </Stack.Navigator>
  );
}

13行目からは、なぜジェネリック型を使うのか、もうおなじみのはずです。ここでstackのルートと型付けが違うのは、@react-navigation/coreからimportしているDefaultNavigatorOptions型くらいでしょう。型の名前そのものが内容を物語っていて、navigatorのためのオプションです。

上で触れたRouteConfig *型* と同じように、*これも複数のジェネリック型を受け取ります。加えて、childrenのキーは明示的に*除外して いることに注意してください。Stack.Screenに対応するStack.Navigator の子要素はすでに描画しているからです。*

22行目では、navigatorのオプションを表す新しいオブジェクトを作っています(navigatorのオプションの型を満たすオブジェクトを返すのであれば、関数でもかまいません)。

その結果、50行目では、このオブジェクトが与えられた型を満たしている限り、スプレッド構文で安全に使えます。

JSXがずっときれいになりました… 個人的には…

最終的な姿: Navigatorのprops

もう一度、典型的なStackの関数が2つの異なるシナリオでどう見えるかを比べてみましょう。

図1: stack navigatorの設定をJSXの中に持つ。

function AppStack() {
  return (
    <Stack.Navigator
      initialRouteName="Home"
      screenOptions={{
        headerShown: false,
        cardOverlayEnabled: true,
        gestureEnabled: false,
        cardStyle: {
          backgroundColor: "royalblue",
        },
        headerLeftContainerStyle: {
          backgroundColor: "firebrick",
        },
        presentation: "modal",
        headerTitleStyle: {
          fontSize: 24,
          color: "olivedrab",
        },
      }}
      // rest...
    >
      {appStackRoutes.map((stackRoute) => (
        <Stack.Screen key={stackRoute.name} {...stackRoute} />
      ))}
    </Stack.Navigator>
  );
}

図2: stack navigatorの設定をJSXから切り離す。

// ...

function AppStack() {
  return (
    <Stack.Navigator {...appStackNavigatorProps}>
      {appStackRoutes.map((stackRoute) => (
        <Stack.Screen key={stackRoute.name} {...stackRoute} />
      ))}
    </Stack.Navigator>
  );
}

まとめ

この記事では、TypeScriptを実際に活用して、react-nativeのnavigatorをよりきれいに構成する方法を扱いました。

みなさん、バグのない一日を。

掲載先

この記事は次の場所でも公開しています。