@react-navigation/bottom-tabs 7.0.0-alpha.1 → 7.0.0-alpha.3

package/src/types.tsx

@@ -254,6 +254,22 @@ export type BottomTabNavigationOptions = HeaderOptions & {
    * Only supported on iOS and Android.
    */
   freezeOnBlur?: boolean;
+
+  /**
+   * Whether transition animations should be enabled when switching tabs.
+   * Defaults to `false`.
+   */
+  animationEnabled?: boolean;
+
+  /**
+   * Function which specifies interpolated styles for bottom-tab scenes.
+   */
+  sceneStyleInterpolator?: BottomTabSceneStyleInterpolator;
+
+  /**
+   * Object which specifies the animation type (timing or spring) and their options (such as duration for timing).
+   */
+  transitionSpec?: TransitionSpec;
 };
 
 export type BottomTabDescriptor = Descriptor<
@@ -264,6 +280,60 @@ export type BottomTabDescriptor = Descriptor<
 
 export type BottomTabDescriptorMap = Record<string, BottomTabDescriptor>;
 
+export type BottomTabSceneInterpolationProps = {
+  /**
+   * Animated value for the current screen:
+   * - -1 if the index is lower than active tab,
+   * - 0 if they're active,
+   * - 1 if the index is higher than active tab
+   */
+  current: Animated.Value;
+};
+
+export type BottomTabSceneInterpolatedStyle = {
+  /**
+   * Interpolated style for the view representing the scene containing screen content.
+   */
+  sceneStyle: Animated.WithAnimatedValue<StyleProp<ViewStyle>>;
+};
+
+export type BottomTabSceneStyleInterpolator = (
+  props: BottomTabSceneInterpolationProps
+) => BottomTabSceneInterpolatedStyle;
+
+export type TransitionSpec =
+  | {
+      animation: 'timing';
+      config: Omit<
+        Animated.TimingAnimationConfig,
+        'toValue' | keyof Animated.AnimationConfig
+      >;
+    }
+  | {
+      animation: 'spring';
+      config: Omit<
+        Animated.SpringAnimationConfig,
+        'toValue' | keyof Animated.AnimationConfig
+      >;
+    };
+
+export type BottomTabTransitionPreset = {
+  /**
+   * Whether transition animations should be enabled when switching tabs.
+   */
+  animationEnabled?: boolean;
+
+  /**
+   * Function which specifies interpolated styles for bottom-tab scenes.
+   */
+  sceneStyleInterpolator?: BottomTabSceneStyleInterpolator;
+
+  /**
+   * Object which specifies the animation type (timing or spring) and their options (such as duration for timing).
+   */
+  transitionSpec?: TransitionSpec;
+};
+
 export type BottomTabNavigationConfig = {
   /**
    * Function that returns a React element to display as the tab bar.

package/src/utils/useAnimatedHashMap.tsx

@@ -0,0 +1,25 @@
+import type { NavigationState } from '@react-navigation/routers';
+import * as React from 'react';
+import { Animated } from 'react-native';
+
+export function useAnimatedHashMap({ routes, index }: NavigationState) {
+  const refs = React.useRef<Record<string, Animated.Value>>({});
+  const previous = refs.current;
+  const routeKeys = Object.keys(previous);
+
+  if (
+    routes.length === routeKeys.length &&
+    routes.every((route) => routeKeys.includes(route.key))
+  ) {
+    return previous;
+  }
+  refs.current = {};
+
+  routes.forEach(({ key }, i) => {
+    refs.current[key] =
+      previous[key] ??
+      new Animated.Value(i === index ? 0 : i >= index ? 1 : -1);
+  });
+
+  return refs.current;
+}

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,25 @@ 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)
+  );
+
   return (
     <SafeAreaProviderCompat>
       <MaybeScreenContainer
         enabled={detachInactiveScreens}
-        hasTwoStates
+        hasTwoStates={hasTwoStates}
         style={styles.container}
       >
         {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,11 +190,31 @@ 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}
             >
@@ -146,7 +233,7 @@ export function BottomTabView(props: Props) {
                       descriptor.navigation as BottomTabNavigationProp<ParamListBase>,
                     options: descriptor.options,
                   })}
-                  style={sceneContainerStyle}
+                  style={[sceneContainerStyle, animationEnabled && sceneStyle]}
                 >
                   {descriptor.render()}
                 </Screen>

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} />;
 }