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={'屏幕' + 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>Home!</Text>
    </View>
  );
}

function SettingsScreen() {
  const [text, setText] = React.useState("点击检查触摸是否有效");
  return (
    <View style={{ flex: 1, justifyContent: 'center', alignItems: 'center' }}>
      <TouchableOpacity onPress={() => setText("触摸有效！")}>
        <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>
  );
}

Material底部选项卡示例

添加以下依赖项：

"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>Home!</Text>
    </View>
  );
}

function SettingsScreen() {
  const [text, setText] = React.useState("点击检查触摸是否有效");
  return (
    <View>
      <TouchableOpacity onPress={() => setText("触摸有效！")}>
        <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>
  );
}

Material顶部选项卡示例

添加以下依赖项：

"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>Home!</Text>
    </View>
  );
}

function SettingsScreen() {
  const [text, setText] = React.useState("点击检查触摸是否有效");
  return (
    <View style={{ flex: 1, justifyContent: 'center', alignItems: 'center' }}>
      <TouchableOpacity onPress={() => setText("触摸有效！")}>
        <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",
      ...
}

将reanimated插件添加到babel.config.js中：

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>Home!</Text>
    </View>
  );
}

function SettingsScreen() {
  const [text, setText] = useState('点击检查触摸是否有效');
  return (
    <View style={{flex: 1, justifyContent: 'center', alignItems: 'center'}}>
      <TouchableOpacity onPress={() => setText('触摸有效！')}>
        <View style={{width: 200, height: 200, backgroundColor: 'skyblue'}}>
          <Text>{text}</Text>
        </View>
      </TouchableOpacity>
      <Text>设置!</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的支持。

导航器

导航器类型	描述
堆栈导航器	在屏幕之间切换应用。每个新屏幕都放在堆栈的顶部。
抽屉导航器	在屏幕侧面渲染一个导航抽屉，可以通过手势打开和关闭该抽屉。
底部选项卡导航器	屏幕底部的简单选项卡栏，可让您在不同的路线之间切换。
Material底部选项卡导航器	屏幕底部以material-design为主题的选项卡栏，可让您通过动画在不同的路线之间切换。此栏中包含`react-native-paper`中的`BottomNavigation`组件。
Material顶部选项卡导航器	屏幕顶部以material-design为主题的选项卡栏，可让您通过点击选项卡或水平滑动来在不同的路线之间切换。此栏中包含`react-native-tab-view`程序包。

组件

组件	描述
NavigationContainer	管理应用状态并将顶级导航器链接到应用环境。
ServerContainer	提供实用工具，使您的应用在服务器上以正确的导航状态渲染。
Group	对导航器内的多个屏幕进行分组。
Screen	在导航器内配置屏幕的各个方面。屏幕组件作为`createXNavigator`函数的一个属性返回。
Link	渲染一个可以在按下时导航到屏幕的组件。在网页上使用时，渲染标签。在其他平台上，则使用`Text`组件。

已知问题和限制

Vega上不支持Flipper插件flipper-plugin-react-navigation。

Material底部选项卡

来回导航后，系统将卸载第2个屏幕上的组件。

上下文的安全区

引用的程序包为更新后的类型使用@amazon-devices/keplerscript-react-native-safe-area-context库。不要直接使用这个库。

支持的版本

Vega之前发布了适用于Vega OS的react-navigation库的旧版本，名为react-navigation版本2.0.0：

"@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 库和服务

安装

示例

堆栈示例

原生堆栈示例

底部选项卡示例

Material底部选项卡示例

Material顶部选项卡示例

抽屉示例

API参考

导航器

组件

已知问题和限制

Material底部选项卡

Material底部选项卡

上下文的安全区

支持的版本