@react-navigation/bottom-tabs 7.0.0-alpha.2 → 7.0.0-alpha.4

package/src/views/BottomTabItem.tsx

@@ -1,3 +1,4 @@
+import { getLabel, Label } from '@react-navigation/elements';
 import { CommonActions, Link, Route, useTheme } from '@react-navigation/native';
 import Color from 'color';
 import React from 'react';
@@ -7,7 +8,6 @@ import {
   Pressable,
   StyleProp,
   StyleSheet,
-  Text,
   TextStyle,
   ViewStyle,
 } from 'react-native';
@@ -195,7 +195,7 @@ export function BottomTabItem({
   iconStyle,
   style,
 }: Props) {
-  const { colors, fonts } = useTheme();
+  const { colors } = useTheme();
 
   const activeTintColor =
     customActiveTintColor === undefined
@@ -214,38 +214,38 @@ export function BottomTabItem({
 
     const color = focused ? activeTintColor : inactiveTintColor;
 
-    if (typeof label === 'string') {
-      return (
-        <Text
-          numberOfLines={1}
-          style={[
-            { color },
-            fonts.regular,
-            styles.label,
-            horizontal ? styles.labelBeside : styles.labelBeneath,
-            labelStyle,
-          ]}
-          allowFontScaling={allowFontScaling}
-        >
-          {label}
-        </Text>
+    if (typeof label !== 'string') {
+      const { options } = descriptor;
+      const children = getLabel(
+        {
+          label:
+            typeof options.tabBarLabel === 'string'
+              ? options.tabBarLabel
+              : undefined,
+          title: options.title,
+        },
+        route.name
       );
-    }
 
-    const { options } = descriptor;
-    const children =
-      typeof options.tabBarLabel === 'string'
-        ? options.tabBarLabel
-        : options.title !== undefined
-        ? options.title
-        : route.name;
+      return label({
+        focused,
+        color,
+        position: horizontal ? 'beside-icon' : 'below-icon',
+        children,
+      });
+    }
 
-    return label({
-      focused,
-      color,
-      position: horizontal ? 'beside-icon' : 'below-icon',
-      children,
-    });
+    return (
+      <Label
+        style={[
+          horizontal ? styles.labelBeside : styles.labelBeneath,
+          labelStyle,
+        ]}
+        allowFontScaling={allowFontScaling}
+      >
+        {label}
+      </Label>
+    );
   };
 
   const renderIcon = ({ focused }: { focused: boolean }) => {
@@ -306,7 +306,6 @@ export function BottomTabItem({
 
 const styles = StyleSheet.create({
   tab: {
-    flex: 1,
     alignItems: 'center',
   },
   tabPortrait: {
@@ -317,17 +316,12 @@ const styles = StyleSheet.create({
     justifyContent: 'center',
     flexDirection: 'row',
   },
-  label: {
-    textAlign: 'center',
-    backgroundColor: 'transparent',
-  },
   labelBeneath: {
     fontSize: 10,
   },
   labelBeside: {
     fontSize: 13,
     marginLeft: 20,
-    marginTop: 3,
   },
   button: {
     display: 'flex',

package/src/views/BottomTabView.tsx

@@ -9,7 +9,7 @@ import type {
   TabNavigationState,
 } from '@react-navigation/native';
 import * as React from 'react';
-import { Platform, StyleSheet } from 'react-native';
+import { Animated, Platform, StyleSheet } from 'react-native';
 import { SafeAreaInsetsContext } from 'react-native-safe-area-context';
 
 import type {
@@ -18,12 +18,15 @@ import type {
   BottomTabHeaderProps,
   BottomTabNavigationConfig,
   BottomTabNavigationHelpers,
+  BottomTabNavigationOptions,
   BottomTabNavigationProp,
 } from '../types';
 import { BottomTabBarHeightCallbackContext } from '../utils/BottomTabBarHeightCallbackContext';
 import { BottomTabBarHeightContext } from '../utils/BottomTabBarHeightContext';
+import { useAnimatedHashMap } from '../utils/useAnimatedHashMap';
 import { BottomTabBar, getTabBarHeight } from './BottomTabBar';
 import { MaybeScreen, MaybeScreenContainer } from './ScreenFallback';
+import CompositeAnimation = Animated.CompositeAnimation;
 
 type Props = BottomTabNavigationConfig & {
   state: TabNavigationState<ParamListBase>;
@@ -31,6 +34,21 @@ type Props = BottomTabNavigationConfig & {
   descriptors: BottomTabDescriptorMap;
 };
 
+const EPSILON = 1e-5;
+const STATE_INACTIVE = 0;
+const STATE_TRANSITIONING_OR_BELOW_TOP = 1;
+const STATE_ON_TOP = 2;
+
+const hasAnimation = (options: BottomTabNavigationOptions) => {
+  const { animationEnabled, transitionSpec } = options;
+
+  if (animationEnabled === false || !transitionSpec) {
+    return false;
+  }
+
+  return true;
+};
+
 export function BottomTabView(props: Props) {
   const {
     tabBar = (props: BottomTabBarProps) => <BottomTabBar {...props} />,
@@ -43,14 +61,54 @@ export function BottomTabView(props: Props) {
       Platform.OS === 'ios',
     sceneContainerStyle,
   } = props;
-
   const focusedRouteKey = state.routes[state.index].key;
+
+  /**
+   * List of loaded tabs, tabs will be loaded when navigated to.
+   */
   const [loaded, setLoaded] = React.useState([focusedRouteKey]);
 
   if (!loaded.includes(focusedRouteKey)) {
+    // Set the current tab to be loaded if it was not loaded before
     setLoaded([...loaded, focusedRouteKey]);
   }
 
+  const tabAnims = useAnimatedHashMap(state);
+
+  React.useEffect(() => {
+    const animateToIndex = () => {
+      Animated.parallel(
+        state.routes
+          .map((route, index) => {
+            const { options } = descriptors[route.key];
+            const { transitionSpec } = options;
+
+            const animationEnabled = hasAnimation(options);
+
+            const toValue =
+              index === state.index ? 0 : index >= state.index ? 1 : -1;
+
+            if (!animationEnabled || !transitionSpec) {
+              return Animated.timing(tabAnims[route.key], {
+                toValue,
+                duration: 0,
+                useNativeDriver: true,
+              });
+            }
+
+            return Animated[transitionSpec.animation](tabAnims[route.key], {
+              ...transitionSpec.config,
+              toValue,
+              useNativeDriver: true,
+            });
+          })
+          .filter(Boolean) as CompositeAnimation[]
+      ).start();
+    };
+
+    animateToIndex();
+  }, [descriptors, state.index, state.routes, tabAnims]);
+
   const dimensions = SafeAreaProviderCompat.initialMetrics.frame;
   const [tabBarHeight, setTabBarHeight] = React.useState(() =>
     getTabBarHeight({
@@ -88,16 +146,35 @@ export function BottomTabView(props: Props) {
 
   const { routes } = state;
 
+  // If there is no animation, we only have 2 states: visible and invisible
+  const hasTwoStates = !routes.some((route) =>
+    hasAnimation(descriptors[route.key].options)
+  );
+
+  const { tabBarPosition = 'bottom' } = descriptors[focusedRouteKey].options;
+
   return (
-    <SafeAreaProviderCompat>
+    <SafeAreaProviderCompat
+      style={
+        tabBarPosition === 'left'
+          ? styles.left
+          : tabBarPosition === 'right'
+          ? styles.right
+          : null
+      }
+    >
       <MaybeScreenContainer
         enabled={detachInactiveScreens}
-        hasTwoStates
-        style={styles.container}
+        hasTwoStates={hasTwoStates}
+        style={styles.screens}
       >
         {routes.map((route, index) => {
           const descriptor = descriptors[route.key];
-          const { lazy = true, unmountOnBlur } = descriptor.options;
+          const {
+            lazy = true,
+            unmountOnBlur,
+            sceneStyleInterpolator,
+          } = descriptor.options;
           const isFocused = state.index === index;
 
           if (unmountOnBlur && !isFocused) {
@@ -123,15 +200,37 @@ export function BottomTabView(props: Props) {
             headerTransparent,
           } = descriptor.options;
 
+          const { sceneStyle } =
+            sceneStyleInterpolator?.({
+              current: tabAnims[route.key],
+            }) ?? {};
+
+          const animationEnabled = hasAnimation(descriptor.options);
+          const activityState = isFocused
+            ? STATE_ON_TOP // the screen is on top after the transition
+            : animationEnabled // is animation is not enabled, immediately move to inactive state
+            ? tabAnims[route.key].interpolate({
+                inputRange: [0, 1 - EPSILON, 1],
+                outputRange: [
+                  STATE_TRANSITIONING_OR_BELOW_TOP, // screen visible during transition
+                  STATE_TRANSITIONING_OR_BELOW_TOP,
+                  STATE_INACTIVE, // the screen is detached after transition
+                ],
+                extrapolate: 'extend',
+              })
+            : STATE_INACTIVE;
+
           return (
             <MaybeScreen
               key={route.key}
               style={[StyleSheet.absoluteFill, { zIndex: isFocused ? 0 : -1 }]}
-              visible={isFocused}
+              active={activityState}
               enabled={detachInactiveScreens}
               freezeOnBlur={freezeOnBlur}
             >
-              <BottomTabBarHeightContext.Provider value={tabBarHeight}>
+              <BottomTabBarHeightContext.Provider
+                value={tabBarPosition === 'bottom' ? tabBarHeight : 0}
+              >
                 <Screen
                   focused={isFocused}
                   route={descriptor.route}
@@ -146,7 +245,7 @@ export function BottomTabView(props: Props) {
                       descriptor.navigation as BottomTabNavigationProp<ParamListBase>,
                     options: descriptor.options,
                   })}
-                  style={sceneContainerStyle}
+                  style={[sceneContainerStyle, animationEnabled && sceneStyle]}
                 >
                   {descriptor.render()}
                 </Screen>
@@ -163,7 +262,13 @@ export function BottomTabView(props: Props) {
 }
 
 const styles = StyleSheet.create({
-  container: {
+  left: {
+    flexDirection: 'row-reverse',
+  },
+  right: {
+    flexDirection: 'row',
+  },
+  screens: {
     flex: 1,
     overflow: 'hidden',
   },

package/src/views/ScreenFallback.tsx

@@ -1,11 +1,10 @@
-import { ResourceSavingView } from '@react-navigation/elements';
 import * as React from 'react';
-import { StyleProp, View, ViewProps, ViewStyle } from 'react-native';
+import { Animated, StyleProp, View, ViewProps, ViewStyle } from 'react-native';
 
 type Props = {
-  visible: boolean;
-  children: React.ReactNode;
   enabled: boolean;
+  active: 0 | 1 | 2 | Animated.AnimatedInterpolation<0 | 1>;
+  children: React.ReactNode;
   freezeOnBlur?: boolean;
   style?: StyleProp<ViewStyle>;
 };
@@ -33,18 +32,12 @@ export const MaybeScreenContainer = ({
   return <View {...rest} />;
 };
 
-export function MaybeScreen({ visible, children, ...rest }: Props) {
+export function MaybeScreen({ enabled, active, ...rest }: ViewProps & Props) {
   if (Screens?.screensEnabled?.()) {
     return (
-      <Screens.Screen activityState={visible ? 2 : 0} {...rest}>
-        {children}
-      </Screens.Screen>
+      <Screens.Screen enabled={enabled} activityState={active} {...rest} />
     );
   }
 
-  return (
-    <ResourceSavingView visible={visible} {...rest}>
-      {children}
-    </ResourceSavingView>
-  );
+  return <View {...rest} />;
 }

package/src/views/TabBarIcon.tsx

@@ -27,6 +27,8 @@ type Props = {
   style: StyleProp<ViewStyle>;
 };
 
+const ICON_SIZE = 25;
+
 export function TabBarIcon({
   route: _,
   horizontal,
@@ -39,8 +41,6 @@ export function TabBarIcon({
   renderIcon,
   style,
 }: Props) {
-  const size = 25;
-
   // We render the icon twice at the same position on top of each other:
   // active and inactive one, so we can fade between them.
   return (
@@ -50,25 +50,21 @@ export function TabBarIcon({
       <View style={[styles.icon, { opacity: activeOpacity }]}>
         {renderIcon({
           focused: true,
-          size,
+          size: ICON_SIZE,
           color: activeTintColor,
         })}
       </View>
       <View style={[styles.icon, { opacity: inactiveOpacity }]}>
         {renderIcon({
           focused: false,
-          size,
+          size: ICON_SIZE,
           color: inactiveTintColor,
         })}
       </View>
       <Badge
         visible={badge != null}
-        style={[
-          styles.badge,
-          horizontal ? styles.badgeHorizontal : styles.badgeVertical,
-          badgeStyle,
-        ]}
-        size={(size * 3) / 4}
+        style={[styles.badge, badgeStyle]}
+        size={ICON_SIZE * 0.75}
       >
         {badge}
       </Badge>
@@ -88,23 +84,19 @@ const styles = StyleSheet.create({
     height: '100%',
     width: '100%',
     // Workaround for react-native >= 0.54 layout bug
-    minWidth: 25,
+    minWidth: ICON_SIZE,
   },
   iconVertical: {
-    flex: 1,
+    width: ICON_SIZE,
+    height: ICON_SIZE,
   },
   iconHorizontal: {
-    height: '100%',
-    marginTop: 3,
+    width: ICON_SIZE,
+    height: ICON_SIZE,
   },
   badge: {
     position: 'absolute',
-    left: 3,
-  },
-  badgeVertical: {
-    top: 3,
-  },
-  badgeHorizontal: {
-    top: 7,
+    right: -5,
+    top: -5,
   },
 });