react-navigation

React Navigation 7.0.0はReact Native アプリ向けの堅牢なナビゲーションライブラリです。画面遷移の管理、ルーティングの処理、ボトムタブ、スタック、ドロワーナビゲーションなどのナビゲーションパターンの実装を簡単に行うことができます。 React Nativeには、ウェブブラウザのような組み込みのナビゲーションAPIがありません。React Navigationはこのナビゲーションを提供します。React Navigationは、iOS、Android、Vegaのジェスチャーやアニメーションと並んで画面間を遷移します。このライブラリはシステムにデプロイされるため、別途インストールプロセスを必要とすることなくVega向けReact Nativeアプリで利用できます。これは、アプリが実行時にリンクする自動リンクライブラリとしてデプロイされます。このライブラリは、そのライブラリがビルドされたVega向けReact Nativeのバージョンとのみ互換性があることが保証されています。アプリのVega向けReact Nativeのバージョンをアップレベルするときは、ライブラリの依存関係をアップレベルするベストプラクティスを検討してください。

インストール

必要なすべてのパッケージの依存関係をpackage.jsonファイルに追加します。以下のパッケージがすべて必要というわけではないので、必要なパッケージのサブセットをアプリに含めてください。

"dependencies": {
    ...
    "@amazon-devices/react-navigation__bottom-tabs": "~7.0.0",
    "@amazon-devices/react-navigation__core": "~7.0.0",
    "@amazon-devices/react-navigation__devtools": "~7.0.0",
    "@amazon-devices/react-navigation__drawer": "~7.0.0",
    "@amazon-devices/react-navigation__elements": "~7.0.0",
    "@amazon-devices/react-navigation__material-bottom-tabs": "~7.0.0",
    "@amazon-devices/react-navigation__material-top-tabs": "~7.0.0",
    "@amazon-devices/react-navigation__native": "~7.0.0",
    "@amazon-devices/react-navigation__native-stack": "~7.0.0",
    "@amazon-devices/react-navigation__react-native-tab-view": "~7.0.0",
    "@amazon-devices/react-navigation__routers": "~7.0.0",
    "@amazon-devices/react-navigation__stack": "~7.0.0",
    ...
}

非表示になった画面をマウント解除するために、@amazon-devices/react-native-screens依存関係を追加します。
"dependencies": { ... "@amazon-devices/react-native-screens": "~2.0.0" ... }
npm installコマンドを使用して、依存関係を再インストールします。

例

スタックの例

以下の依存関係を追加します。

"dependencies": {
      ...
      "@amazon-devices/react-navigation__stack": "~7.0.0",
      "@amazon-devices/react-navigation__native": "~7.0.0",
      "@amazon-devices/react-native-screens": "~2.0.0",
      ...
}

次のコードをApp.tsxファイルに貼り付けます。

import {enableFreeze, enableScreens} from '@amazon-devices/react-native-screens';
import {NavigationContainer} from '@amazon-devices/react-navigation__native';
import {createStackNavigator} from '@amazon-devices/react-navigation__stack';
import * as React from 'react';
import {StyleSheet, Text, TouchableOpacity, View} from 'react-native';

function generateRandomColors(n: number): string[] {
  const generatedColors: string[] = [];

  for (let i = 0; i < n; i++) {
    const red = Math.floor(Math.random() * 128 + 64);
    const green = Math.floor(Math.random() * 128 + 64);
    const blue = Math.floor(Math.random() * 128 + 64);
    const hex = `#${red.toString(16).padStart(2, '0')}${green
      .toString(16)
      .padStart(2, '0')}${blue.toString(16).padStart(2, '0')}`;
    generatedColors.push(hex);
  }

  return generatedColors;
}

enableScreens();
enableFreeze();

const Stack = createStackNavigator();

const styles = StyleSheet.create({
  screenContainer: {
    flex: 1,
    alignItems: 'center',
    justifyContent: 'center',
  },
  text: {
    fontSize: 30,
  },
  button: {
    width: 200,
    height: 100,
    alignItems: 'center',
    justifyContent: 'center',
  },
  buttonContainer: {
    flexWrap: 'wrap',
  },
});

const numberOfScreens = 4;

const colors = generateRandomColors(numberOfScreens);

const Screen = ({navigation, route}: {navigation: any; route: any}) => {
  const {id} = route.params;
  return (
    <View style={[styles.screenContainer, {backgroundColor: colors[id]}]}>
      <Text style={styles.text}>SCREEN {id}</Text>
      <View style={styles.buttonContainer}>
        {colors.map((color, buttonId) => (
          <TouchableOpacity
            onPress={() => navigation.navigate('Screen' + buttonId)}>
            <View style={[styles.button, {backgroundColor: color}]}>
              <Text>Go to screen #{buttonId}</Text>
            </View>
          </TouchableOpacity>
        ))}
        <TouchableOpacity onPress={() => navigation.goBack()}>
          <View style={[styles.button, {backgroundColor: 'white'}]}>
            <Text>{'前の画面に戻る'}</Text>
          </View>
        </TouchableOpacity>
      </View>
    </View>
  );
};

const screenOptions = {animationEnabled: true};
export const App = () => (
  <NavigationContainer>
    <Stack.Navigator screenOptions={screenOptions} detachInactiveScreens>
      {colors.map((_, id) => (
        <Stack.Screen
          key={id}
          name={'Screen' + id}
          component={Screen}
          initialParams={{id}}
          options={screenOptions}
        />
      ))}
    </Stack.Navigator>
  </NavigationContainer>
);

ネイティブスタックの例

以下の依存関係を追加します。

"dependencies": {
      ...
      "@amazon-devices/react-navigation__native-stack": "~7.0.0",
      "@amazon-devices/react-navigation__native": "~7.0.0",
      "@amazon-devices/react-native-screens": "~2.0.0",
      "@amazon-devices/react-native-safe-area-context": "~2.0.0",
      ...
}

次のコードをApp.tsxファイルに貼り付けます。

import {enableFreeze, enableScreens} from '@amazon-devices/react-native-screens';
import {createNativeStackNavigator} from '@amazon-devices/react-native-screens/native-stack';
import {NavigationContainer} from '@amazon-devices/react-navigation__native';
import * as React from 'react';
import {StyleSheet, Text, TouchableOpacity, View} from 'react-native';

function generateRandomColors(n: number): string[] {
  const generatedColors: string[] = [];

  for (let i = 0; i < n; i++) {
    const red = Math.floor(Math.random() * 128 + 64);
    const green = Math.floor(Math.random() * 128 + 64);
    const blue = Math.floor(Math.random() * 128 + 64);
    const hex = `#${red.toString(16).padStart(2, '0')}${green
      .toString(16)
      .padStart(2, '0')}${blue.toString(16).padStart(2, '0')}`;
    generatedColors.push(hex);
  }

  return generatedColors;
}

enableScreens();
enableFreeze();

const Stack = createNativeStackNavigator();

const styles = StyleSheet.create({
  screenContainer: {
    flex: 1,
    alignItems: 'center',
    justifyContent: 'center',
  },
  text: {
    fontSize: 30,
  },
  button: {
    width: 200,
    height: 100,
    alignItems: 'center',
    justifyContent: 'center',
  },
  buttonContainer: {
    flexWrap: 'wrap',
  },
});

const numberOfScreens = 4;

const colors = generateRandomColors(numberOfScreens);

const Screen = ({navigation, route}: {navigation: any; route: any}) => {
  const {depth, id} = route.params;
  return (
    <View
      style={[
        styles.screenContainer,
        {backgroundColor: colors[id], margin: 20 * depth},
      ]}>
      <Text style={styles.text}>SCREEN {id}</Text>
      <View style={styles.buttonContainer}>
        {colors.map((color, buttonId) => (
          <TouchableOpacity
            onPress={() =>
              navigation.navigate('Screen' + buttonId, {depth: depth + 1})
            }>
            <View style={[styles.button, {backgroundColor: color}]}>
              <Text>Go to screen #{buttonId}</Text>
            </View>
          </TouchableOpacity>
        ))}
        <TouchableOpacity onPress={() => navigation.goBack()}>
          <View style={[styles.button, {backgroundColor: 'white'}]}>
            <Text>{'前の画面に戻る'}</Text>
          </View>
        </TouchableOpacity>
      </View>
    </View>
  );
};

const screenOptions = {presentation: 'transparentModal', headerShown: false};

export const App = () => (
  <NavigationContainer>
    <Stack.Navigator screenOptions={screenOptions}>
      {colors.map((_, id) => (
        <Stack.Screen
          key={id}
          name={'Screen' + id}
          component={Screen}
          initialParams={{id, depth: 0}}
          options={screenOptions}
        />
      ))}
    </Stack.Navigator>
  </NavigationContainer>
);

ボトムタブの例

以下の依存関係を追加します。

"dependencies": {
      ...
      "@amazon-devices/react-navigation__bottom-tabs": "~7.0.0",
      "@amazon-devices/react-navigation__native": "~7.0.0",
      "@amazon-devices/react-native-screens": "~2.0.0",
      ...
}

次のコードをApp.tsxファイルに貼り付けます。

import { enableScreens } from '@amazon-devices/react-native-screens';
import { createBottomTabNavigator } from '@amazon-devices/react-navigation__bottom-tabs';
import { NavigationContainer } from '@amazon-devices/react-navigation__native';
import * as React from 'react';
import { Text, TouchableOpacity,View } from 'react-native';

enableScreens();

function HomeScreen() {
  return (
    <View style={{ flex: 1, justifyContent: 'center', alignItems: 'center' }}>
      <Text>ホーム!</Text>
    </View>
  );
}

function SettingsScreen() {
  const [text, setText] = React.useState("Press me to check if touches work");
  return (
    <View style={{ flex: 1, justifyContent: 'center', alignItems: 'center' }}>
      <TouchableOpacity onPress={() => setText("Touching works!")}>
        <View style={{ width: 200, height: 200, backgroundColor: "skyblue" }}>
          <Text>{text}</Text>
        </View>
      </TouchableOpacity>
      <Text>設定!</Text>
    </View>
  );
}

const Tab = createBottomTabNavigator();

export const App = () => {
  return (
    <NavigationContainer>
      <Tab.Navigator detachInactiveScreens>
        <Tab.Screen name="ホーム" component={HomeScreen} />
        <Tab.Screen name="設定" component={SettingsScreen} />
      </Tab.Navigator>
    </NavigationContainer>
  );
}

マテリアルボトムタブの例

以下の依存関係を追加します。

"dependencies": {
      ...
      "@amazon-devices/react-navigation__material-bottom-tabs": "~7.0.0",
      "@amazon-devices/react-navigation__native": "~7.0.0",
      "@amazon-devices/react-native-screens": "~2.0.0",
      "@amazon-devices/react-native-safe-area-context": "~2.0.0",
      "react-native-paper": "4.12.1"
      ...
}

次のコードをApp.tsxファイルに貼り付けます。

import { enableFreeze, enableScreens } from '@amazon-devices/react-native-screens';
import { createMaterialBottomTabNavigator } from '@amazon-devices/react-navigation__material-bottom-tabs';
import { NavigationContainer } from '@amazon-devices/react-navigation__native';
import * as React from 'react';
import { Text, TouchableOpacity, View } from 'react-native';

enableScreens();
enableFreeze();

function HomeScreen() {
  return (
    <View style={{ flex: 1, justifyContent: 'center', alignItems: 'center' }}>
      <Text>ホーム!</Text>
    </View>
  );
}

function SettingsScreen() {
  const [text, setText] = React.useState("Press me to check if touches work");
  return (
    <View>
      <TouchableOpacity onPress={() => setText("Touching works!")}>
        <View style={{ width: 200, height: 200, backgroundColor: "skyblue" }}>
          <Text>{text}</Text>
        </View>
      </TouchableOpacity>
      <Text>設定!</Text>
    </View>
  );
}

const Tab =
  createMaterialBottomTabNavigator();

export const App = () => {
  return (
    <View style={{flex: 1}}>
    <NavigationContainer>
      <Tab.Navigator>
        <Tab.Screen name="ホーム" component={HomeScreen} />
        <Tab.Screen name="設定" component={SettingsScreen} />
      </Tab.Navigator>
    </NavigationContainer>
    <View style={{flex: 1}}></View>
    </View>
  );
}

マテリアルトップタブの例

以下の依存関係を追加します。

"dependencies": {
      ...
      "@amazon-devices/react-navigation__material-top-tabs": "~7.0.0",
      "@amazon-devices/react-navigation__native": "~7.0.0",
      "@amazon-devices/react-native-screens": "~2.0.0"
      ...
}

次のコードをApp.tsxファイルに貼り付けます。

import { enableFreeze, enableScreens } from '@amazon-devices/react-native-screens';
import { createMaterialTopTabNavigator } from '@amazon-devices/react-navigation__material-top-tabs';
import { NavigationContainer } from '@amazon-devices/react-navigation__native';
import * as React from 'react';
import { Text, TouchableOpacity,View } from 'react-native';

enableScreens();
enableFreeze();

function HomeScreen() {
  return (
    <View style={{ flex: 1, justifyContent: 'center', alignItems: 'center' }}>
      <Text>ホーム!</Text>
    </View>
  );
}

function SettingsScreen() {
  const [text, setText] = React.useState("Press me to check if touches work");
  return (
    <View style={{ flex: 1, justifyContent: 'center', alignItems: 'center' }}>
      <TouchableOpacity onPress={() => setText("Touching works!")}>
        <View style={{ width: 200, height: 200, backgroundColor: "skyblue" }}>
          <Text>{text}</Text>
        </View>
      </TouchableOpacity>
      <Text>設定!</Text>
    </View>
  );
}

const Tab =
createMaterialTopTabNavigator();

export const App = () => {
  return (
    <NavigationContainer>
      <Tab.Navigator>
        <Tab.Screen name="ホーム" component={HomeScreen} />
        <Tab.Screen name="設定" component={SettingsScreen} />
      </Tab.Navigator>
    </NavigationContainer>
  );
}

ドロワーの例

以下の依存関係を追加します。

"dependencies": {
      ...
      "@amazon-devices/react-native-gesture-handler": "~2.0.0",
      "@amazon-devices/react-native-reanimated": "~2.0.0",
      "@amazon-devices/react-navigation__drawer": "~7.0.0",
      "@amazon-devices/react-navigation__native": "~7.0.0",
      ...
}

babel.config.jsにreanimatedプラグインを追加します。

module.exports = {
  presets: [...],
  plugins: ['@amazon-devices/react-native-reanimated/plugin'] // ここに追加します
};

アプリを実行する前にMetroのキャッシュをリセットします。

npm start -- --reset-cache

次のコードをApp.tsxファイルに貼り付けます。

import {GestureHandlerRootView} from '@amazon-devices/react-native-gesture-handler';
import {createDrawerNavigator} from '@amazon-devices/react-navigation__drawer';
import {NavigationContainer} from '@amazon-devices/react-navigation__native';
import React, {useState} from 'react';
import {Text, TouchableOpacity, View} from 'react-native';

function HomeScreen() {
  return (
    <View style={{flex: 1, justifyContent: 'center', alignItems: 'center'}}>
      <Text>ホーム!</Text>
    </View>
  );
}

function SettingsScreen() {
  const [text, setText] = useState('Press me to check if touches work');
  return (
    <View style={{flex: 1, justifyContent: 'center', alignItems: 'center'}}>
      <TouchableOpacity onPress={() => setText('Touching works!')}>
        <View style={{width: 200, height: 200, backgroundColor: 'skyblue'}}>
          <Text>{text}</Text>
        </View>
      </TouchableOpacity>
      <Text>Settings!</Text>
    </View>
  );
}

const Drawer = createDrawerNavigator();

export const App = () => (
  <GestureHandlerRootView style={{flex: 1, backgroundColor: 'white'}}>
    <NavigationContainer>
      <Drawer.Navigator initialRouteName="Home" detachInactiveScreens={false}>
        <Drawer.Screen name="Home" component={HomeScreen} />
        <Drawer.Screen name="Settings" component={SettingsScreen} />
      </Drawer.Navigator>
    </NavigationContainer>
  </GestureHandlerRootView>
);

APIリファレンス

VegaのReact-Navigationライブラリは、React-Navigation v6で利用可能なすべてのAPIのサポートを追加します。

ナビゲータータイプ

ナビゲーションタイプ	説明
スタックナビゲーター	アプリを画面間で切り替えます。新しい画面はそれぞれスタックの上に配置されます。
ドロワーナビゲーター	ジェスチャーで開閉できるナビゲーションドロワーを画面の横にレンダリングします。
ボトムタブナビゲーター	画面下部にあるシンプルなタブバーで、ルートの切り替えを行うことができます。
マテリアルボトムタブナビゲーター	画面下部にあるマテリアルデザインをテーマとしてタブバーで、アニメーションをともなうルートの切り替えを行うことができます。このバーは、`react-native-paper`の`BottomNavigation`コンポーネントをラップしています。
マテリアルトップタブナビゲーター	画面上部にあるマテリアルデザインをテーマにしたタブバーで、タブをタップしたり水平方向にスワイプしたりすることで、ルートの切り替えを行うことができます。このバーは、`react-native-tab-view`パッケージをラップしています。

コンポーネント

コンポーネント	説明
NavigationContainer	アプリの状態を管理し、最上位のナビゲーターをアプリ環境にリンクします。
ServerContainer	アプリを適切なナビゲーション状態でサーバー上にレンダリングするためのユーティリティを提供します。
Group	ナビゲーター内の複数の画面をグループ化します。
Screen	ナビゲーター内の画面のさまざまな要素を設定します。このコンポーネントは、`createXNavigator`関数の属性のひとつとして返されます。
Link	押されると画面に移動するコンポーネントをレンダリングします。ウェブで使用する場合はタグをレンダリングし、他のプラットフォームでは`Text`コンポーネントを使用します。

既知の問題と制限事項

flipper-plugin-react-navigationはVegaではサポートされていません。

マテリアルボトムタブ

2番目の画面のコンポーネントが、他の画面に移動して再度戻るとマウント解除されます。

コンテキストのセーフエリア

参照パッケージは、更新された型に@amazon-devices/keplerscript-react-native-safe-area-contextライブラリを使用します。このライブラリを直接使用しないでください。

サポートされているバージョン

Vegaでは以前に、react-navigationバージョン2.0.0という古いバージョンのreact-navigationライブラリをVega OS向けにリリースしました。

"@amazon-devices/react-navigation__bottom-tabs": "~2.0.0"
"@amazon-devices/react-navigation__core": "~2.0.0"
"@amazon-devices/react-navigation__devtools": "~2.0.0"
"@amazon-devices/react-navigation__drawer": "~2.0.0"
"@amazon-devices/react-navigation__elements": "~2.0.0"
"@amazon-devices/react-navigation__material-bottom-tabs": "~2.0.0"
"@amazon-devices/react-navigation__material-top-tabs": "~2.0.0"
"@amazon-devices/react-navigation__native": "~2.0.0"
"@amazon-devices/react-navigation__native-stack": "~2.0.0"
"@amazon-devices/react-navigation__react-native-tab-view": "~2.0.0"
"@amazon-devices/react-navigation__routers": "~2.0.0"
"@amazon-devices/react-navigation__stack": "~2.0.0"

Vegaプライベートベータの既存のユーザーは、これらの実験的機能を各自の判断で引き続き利用できます。ただし現在、react-navigationバージョン2.0.0のドキュメントに新しい開発者がアクセスすることはできません。

Vegaライブラリとサービス

インストール

例

スタックの例

ネイティブスタックの例

ボトムタブの例

マテリアルボトムタブの例

マテリアルトップタブの例

ドロワーの例

APIリファレンス

ナビゲータータイプ

コンポーネント

既知の問題と制限事項

マテリアルボトムタブ

コンテキストのセーフエリア

サポートされているバージョン