React Navigation 6.0のStack Navigatorの大きく変わった箇所の変更点をまとめてみた

はじめに

先日React Navigation 6.0が公開されました。
この記事では今回のバージョンアップによる新機能や変更点をいくつか紹介していきたいと思います。 React Navigation 6.0を使用するために以下の条件を満たす必要があります。

react-native-safe-area-context >= 3.0.0
react-native-screens >= 2.15.0
react-native-tab-view >= 3.0.0
react-native >= 0.63.0
expo >= 41
typescript >= 4.1.0 

React Navigationとは

React Navigationは、React Nativeアプリケーションでルーティングとナビゲーションを行うためのライブラリです。
React Navigationを使用することで、複数の画面間に遷移したり、画面間でデータを共有する際の問題を解決するのに役立ちます。

React Navigation使用するためにプロジェクト内で以下のコマンドを入力する

npm install @react-navigation/native

//React Native CLIプロジェクトの場合は下記を入力
npm install react-native-screens react-native-safe-area-context

//Expoプロジェクトの場合は下記を入力
expo install react-native-screens react-native-safe-area-context

React Navigation6.0のStack Navigatorの大きく変わった箇所の変更点

カスタムヘッダーの「headerMode: screen」がデフォルトで指定される

これまでカスタムヘッダーを使用する時に、下記のようにheaderMode='screen'またはカスタムアニメーションを手動で指定する必要がありました。

//v5
<Stack.Navigator headerMode="screen">
  ...
</Stack.Navigator>

v6からはカスタムヘッダーを指定すると、自動的にheaderMode='screen'に設定されるようになります。これはheaderModeがナビゲーターのpropではなくなり、カスタムヘッダーが指定された画面ごとに設定できるようになりました。

//v6
//記述しなくてもheaderMode='screen'がデフォルトで設定されている
<Stack.Navigator>
  ...
</Stack.Navigator>

カスタムヘッダーに渡されるpropが合理化される

v5まではstack headerは現在の画面と遷移前の画面の状態を受け取り、それらにはdescriptor, navigation prop、progressなどが含まれていました。v6からpropはより簡素になりました。 header関連のオプション一覧は以下になります。これらのオプションはStack.navigatorのscreenOptionsやStack.Screenのoptionsで指定できます headerとして表示するReact Elementを返す関数です。引数として、以下のプロパティを含むオブジェクトを受け取ります。 navigatorのすべての画面にカスタムヘッダーを設定するには、ナビゲーターのscreenOptionsでこのオプションを指定します。

import { createStackNavigator } from '@react-navigation/stack';
const Stack = createStackNavigator();

function MyStack() {
  return (
    <Stack.Navigator
      initialRouteName="Home"

       //ここで全ての画面で共通するカスタムヘッダーを指定する
      screenOptions={{
        headerMode: 'screen',
        headerTintColor: 'white',
        headerStyle: { backgroundColor: 'tomato' },
      }}
    >
  ....
 </Stack.Navigator>
  );
};

カスタムヘッダーを使う場合の2つの注意点

不具合を防ぐためにheaderStyleで高さを指定する

headerの高さがデフォルトのheaderの高さと異なる場合、計測が非同期になることで不具合が発生する可能性があります。明示的に高さを指定することで、そのような不具合を避けることができます。

headerStyle: {
  height: 80, // Specify the height of your custom header
};

カスタムヘッダーアニメーションのために headerMode を float に設定する

デフォルトの非モーダルのiOSでは、複数の画面用のheaderをレンダリングするfloating headerが1つあります。これらのheaderにはスムーズに切り替えるためのアニメーションが含まれています。カスタムヘッダーを指定した場合、React Navigationは自動的に画面に変更し、代わりにheaderが画面に合わせてアニメーションするようにします。そのため個別にアニメーションを実装する必要がありません。 しかし、floating headerを維持して、header間で異なる遷移アニメーションをさせたい場合があります。そのためには、オプションで headerMode: 'float' を指定し、カスタムヘッダーの progress.current と progress.next のpropで補間する必要があります。例えば、以下のようにすると、headerがクロスフェードします。

import Animated from 'react-native-reanimated';
import progress from 'progress';

const opacity = Animated.add(progress.current, progress.next || 0).interpolate({
  inputRange: [0, 1, 2],
  outputRange: [0, 1, 0],
});

return (
  <Animated.View style={{ opacity }}>{/* Header content */}</Animated.View>
);

gestureResponseDistanceオプションをオブジェクトではなく数値で指定する。

v5まではgestureResponseDistanceオプションは水平または垂直のプロパティを持つオブジェクトを受け取っていました。v6からはgestureDirectionオプションに基づいて、水平または垂直方向の値として使用される数値を受け取ります。

//v5
<Stack.Navigator 
     screenOptions={
       gestureResponseDistance: {
          horizontal:100,
          vertical:50
       }}
    >

//v6
<Stack.Navigator
      screenOptions={{
        headerStyle: { backgroundColor: 'tomato' },
        gestureResponseDistance: 50,
      }}
    >

一部の要素がElements Libraryに変更

以下のエクスポートはstack navigatorに固有のものではなくなったため、Elements Libraryへの変更となりました。 使用する場合は下記のようにします。

 import { BlurView } from 'expo-blur';

// ...

<Stack.Screen
  name="Setting"
  component={SettingScreen}
  options={{
    headerTransparent: true,
    headerBackground: () => (
      <BlurView tint="light" intensity={90}  />
    ),
  }}
/>;

まとめ

今回はReact Navigation6.0のStack Navigatorの変更点を説明しました。
v6ではv5とほとんど同じコアAPIを維持しており、よりシンプルで使いやすくなっています。 今回紹介したものはv6で変更のあった中の一部なので、他にも詳しく知りたい方は公式のドキュメントを見てみてください。 ご覧いただきありがとうございました。