@react-navigation/bottom-tabs 8.0.0-alpha.13 → 8.0.0-alpha.14

package/src/views/BottomTabViewCustom.tsx

@@ -1,5 +1,6 @@
 import {
-  Lazy,
+  ActivityView,
+  Container,
   SafeAreaProviderCompat,
 } from '@react-navigation/elements/internal';
 import {
@@ -16,7 +17,6 @@ import {
   StyleSheet,
   type ViewStyle,
 } from 'react-native';
-import { Screen, ScreenContainer } from 'react-native-screens';
 
 import {
   FadeTransition,
@@ -44,11 +44,6 @@ 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 NAMED_TRANSITIONS_PRESETS = {
   fade: FadeTransition,
   shift: ShiftTransition,
@@ -82,22 +77,43 @@ export function BottomTabViewCustom({
   state,
   navigation,
   descriptors,
-  detachInactiveScreens = Platform.OS === 'web' ||
-    Platform.OS === 'android' ||
-    Platform.OS === 'ios',
 }: Props) {
   const { routes } = state;
   const focusedRouteKey = routes[state.index].key;
 
-  const previousRouteKeyRef = React.useRef(focusedRouteKey);
+  const [loaded, setLoaded] = React.useState([focusedRouteKey]);
+
+  if (!loaded.includes(focusedRouteKey)) {
+    setLoaded([...loaded, focusedRouteKey]);
+  }
+
+  const [lastUpdate, setLastUpdate] = React.useState<{
+    current: string;
+    previous?: string;
+  }>({
+    current: focusedRouteKey,
+  });
+
+  if (lastUpdate.current !== focusedRouteKey) {
+    setLastUpdate({
+      current: focusedRouteKey,
+      previous: lastUpdate.current,
+    });
+  }
+
   const tabAnims = useAnimatedHashMap(state);
 
+  const [isAnimating, setIsAnimating] = React.useState(false);
+
+  const previousRouteKeyRef = React.useRef(focusedRouteKey);
+
   React.useEffect(() => {
     const previousRouteKey = previousRouteKeyRef.current;
 
     let popToTopAction: NavigationAction | undefined;
 
     if (
+      previousRouteKey &&
       previousRouteKey !== focusedRouteKey &&
       descriptors[previousRouteKey]?.options.popToTopOnBlur
     ) {
@@ -105,6 +121,12 @@ export function BottomTabViewCustom({
         (route) => route.key === previousRouteKey
       );
 
+      console.log(
+        'checking if we need to pop to top for route',
+        previousRouteKey,
+        focusedRouteKey
+      );
+
       if (prevRoute?.state?.type === 'stack' && prevRoute.state.key) {
         popToTopAction = {
           ...StackActions.popToTop(),
@@ -113,6 +135,8 @@ export function BottomTabViewCustom({
       }
     }
 
+    let timer: ReturnType<typeof setTimeout>;
+
     const animateToIndex = () => {
       if (previousRouteKey !== focusedRouteKey) {
         navigation.emit({
@@ -121,42 +145,45 @@ export function BottomTabViewCustom({
         });
       }
 
-      Animated.parallel(
-        state.routes
-          .map((route, index) => {
-            const { options } = descriptors[route.key];
-            const {
-              animation = 'none',
-              transitionSpec = NAMED_TRANSITIONS_PRESETS[animation]
-                .transitionSpec,
-            } = options;
-
-            let spec = transitionSpec;
-
-            if (
-              route.key !== previousRouteKey &&
-              route.key !== focusedRouteKey
-            ) {
-              // Don't animate if the screen is not previous one or new one
-              // This will avoid flicker for screens not involved in the transition
-              spec = NAMED_TRANSITIONS_PRESETS.none.transitionSpec;
-            }
-
-            spec = spec ?? NAMED_TRANSITIONS_PRESETS.none.transitionSpec;
-
-            const toValue =
-              index === state.index ? 0 : index >= state.index ? 1 : -1;
-
-            return Animated[spec.animation](tabAnims[route.key], {
-              ...spec.config,
-              toValue,
-              useNativeDriver,
-            });
-          })
-          .filter(Boolean) as Animated.CompositeAnimation[]
-      ).start(({ finished }) => {
+      const animations = state.routes
+        .map((route, index) => {
+          const { options } = descriptors[route.key];
+          const {
+            animation = 'none',
+            transitionSpec = NAMED_TRANSITIONS_PRESETS[animation]
+              .transitionSpec,
+          } = options;
+
+          let spec = transitionSpec;
+
+          if (route.key !== previousRouteKey && route.key !== focusedRouteKey) {
+            // Don't animate if the screen is not previous one or new one
+            // This will avoid flicker for screens not involved in the transition
+            spec = NAMED_TRANSITIONS_PRESETS.none.transitionSpec;
+          }
+
+          spec = spec ?? NAMED_TRANSITIONS_PRESETS.none.transitionSpec;
+
+          const toValue =
+            index === state.index ? 0 : index >= state.index ? 1 : -1;
+
+          return Animated[spec.animation](tabAnims[route.key], {
+            ...spec.config,
+            toValue,
+            useNativeDriver,
+          });
+        })
+        .filter((anim) => anim != null);
+
+      if (animations.length) {
+        // eslint-disable-next-line @eslint-react/hooks-extra/no-direct-set-state-in-use-effect
+        setIsAnimating(true);
+      }
+
+      Animated.parallel(animations).start(({ finished }) => {
         if (finished && popToTopAction) {
-          navigation.dispatch(popToTopAction);
+          console.log('dispatching pop to top action', popToTopAction);
+          // navigation.dispatch(popToTopAction);
         }
 
         if (previousRouteKey !== focusedRouteKey) {
@@ -165,12 +192,24 @@ export function BottomTabViewCustom({
             target: focusedRouteKey,
           });
         }
+
+        if (finished && animations.length) {
+          // Delay clearing `isAnimating`
+          // This will give time for `popToAction` to get handled before pause
+          timer = setTimeout(() => {
+            setIsAnimating(false);
+          }, 32);
+        }
       });
     };
 
     animateToIndex();
 
     previousRouteKeyRef.current = focusedRouteKey;
+
+    return () => {
+      clearTimeout(timer);
+    };
   }, [
     descriptors,
     focusedRouteKey,
@@ -203,11 +242,6 @@ export function BottomTabViewCustom({
     </BottomTabBarHeightCallbackContext.Provider>
   );
 
-  // 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 = useTabBarPosition(
     descriptors[focusedRouteKey].options
   );
@@ -224,12 +258,7 @@ export function BottomTabViewCustom({
       {tabBarPosition === 'top' || tabBarPosition === 'left'
         ? tabBarElement
         : null}
-      <ScreenContainer
-        key="screens"
-        enabled={detachInactiveScreens}
-        hasTwoStates={hasTwoStates}
-        style={styles.screens}
-      >
+      <Container key="screens" style={styles.screens}>
         {routes.map((route, index) => {
           const descriptor = descriptors[route.key];
 
@@ -237,6 +266,7 @@ export function BottomTabViewCustom({
 
           const {
             lazy = true,
+            inactiveBehavior = 'pause',
             animation = 'none',
             sceneStyleInterpolator = NAMED_TRANSITIONS_PRESETS[animation]
               .sceneStyleInterpolator,
@@ -246,6 +276,16 @@ export function BottomTabViewCustom({
           const isFocused = state.index === index;
           const isPreloaded = state.preloadedRouteKeys.includes(route.key);
 
+          if (
+            lazy &&
+            !loaded.includes(route.key) &&
+            !isFocused &&
+            !isPreloaded
+          ) {
+            // Don't render a lazy screen if we've never navigated to it or it wasn't preloaded
+            return null;
+          }
+
           const animationEnabled = hasAnimation(descriptor.options);
 
           const content = (
@@ -254,75 +294,48 @@ export function BottomTabViewCustom({
               progress={tabAnims[route.key]}
               animationEnabled={animationEnabled}
               sceneStyleInterpolator={sceneStyleInterpolator}
-              style={customSceneStyle}
+              style={[StyleSheet.absoluteFill, customSceneStyle]}
             >
-              <Lazy enabled={lazy} visible={isFocused || isPreloaded}>
-                <ScreenContent
-                  isFocused={isFocused}
-                  route={route}
-                  navigation={navigation}
-                  options={options}
-                  style={
-                    Platform.OS === 'web'
-                      ? {
-                          /**
-                           * Don't use react-native-screens on web:
-                           * - It applies display: none as fallback, which triggers `onLayout` events
-                           * - We still need to hide the view when screens is not enabled
-                           */
-                          ...StyleSheet.absoluteFillObject,
-                          visibility: isFocused ? 'visible' : 'hidden',
-                        }
-                      : undefined
-                  }
+              <ScreenContent
+                isFocused={isFocused}
+                route={route}
+                navigation={navigation}
+                options={options}
+              >
+                <BottomTabBarHeightContext.Provider
+                  value={tabBarPosition === 'bottom' ? tabBarHeight : 0}
                 >
-                  <BottomTabBarHeightContext.Provider
-                    value={tabBarPosition === 'bottom' ? tabBarHeight : 0}
-                  >
-                    {render()}
-                  </BottomTabBarHeightContext.Provider>
-                </ScreenContent>
-              </Lazy>
+                  {render()}
+                </BottomTabBarHeightContext.Provider>
+              </ScreenContent>
             </AnimatedScreenContent>
           );
 
-          if (Platform.OS === 'web') {
-            return content;
-          }
+          const isAnimatingRoute =
+            isAnimating &&
+            (lastUpdate.previous === route.key ||
+              lastUpdate.current === route.key);
 
-          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;
+          // For preloaded screens and if lazy is false,
+          // Keep them active so that the effects can run
+          const isActive =
+            inactiveBehavior === 'none' ||
+            isAnimatingRoute ||
+            isPreloaded ||
+            (lazy === false && !loaded.includes(route.key));
 
           return (
-            <Screen
+            <ActivityView
               key={route.key}
-              style={[
-                StyleSheet.absoluteFill,
-                {
-                  zIndex: isFocused ? 0 : -1,
-                  pointerEvents: isFocused ? 'auto' : 'none',
-                },
-              ]}
-              activityState={activityState}
-              enabled={detachInactiveScreens}
-              shouldFreeze={activityState === STATE_INACTIVE && !isPreloaded}
+              mode={isFocused ? 'normal' : isActive ? 'inert' : 'paused'}
+              visible={isFocused || isAnimatingRoute}
+              style={{ ...StyleSheet.absoluteFill, zIndex: isFocused ? 0 : -1 }}
             >
               {content}
-            </Screen>
+            </ActivityView>
           );
         })}
-      </ScreenContainer>
+      </Container>
       {tabBarPosition === 'bottom' || tabBarPosition === 'right'
         ? tabBarElement
         : null}
@@ -339,7 +352,7 @@ function AnimatedScreenContent({
 }: {
   progress: Animated.Value;
   animationEnabled: boolean;
-  sceneStyleInterpolator?: BottomTabSceneStyleInterpolator;
+  sceneStyleInterpolator?: BottomTabSceneStyleInterpolator | undefined;
   children: React.ReactNode;
   style: StyleProp<ViewStyle>;
 }) {

package/src/views/BottomTabViewNativeImpl.tsx

@@ -1,7 +1,7 @@
 import { getLabel } from '@react-navigation/elements';
 import {
+  ActivityView,
   Color,
-  Lazy,
   SafeAreaProviderCompat,
 } from '@react-navigation/elements/internal';
 import {
@@ -20,6 +20,7 @@ import {
   type ColorValue,
   Platform,
   PlatformColor,
+  StyleSheet,
 } from 'react-native';
 import {
   type PlatformIcon,
@@ -62,6 +63,18 @@ export function BottomTabViewNative({
   const { dark, colors, fonts } = useTheme();
 
   const focusedRouteKey = state.routes[state.index].key;
+
+  const [loaded, setLoaded] = React.useState([focusedRouteKey]);
+
+  if (!loaded.includes(focusedRouteKey)) {
+    setLoaded([...loaded, focusedRouteKey]);
+  }
+
+  const [pendingNavigation, setPendingNavigation] = React.useState<{
+    from: string;
+    to: string;
+  } | null>(null);
+
   const previousRouteKeyRef = React.useRef(focusedRouteKey);
 
   React.useEffect(() => {
@@ -80,11 +93,26 @@ export function BottomTabViewNative({
           ...StackActions.popToTop(),
           target: prevRoute.state.key,
         };
+
         navigation.dispatch(popToTopAction);
       }
     }
 
     previousRouteKeyRef.current = focusedRouteKey;
+
+    // Delay clearing `isAnimating`
+    // This will give time for `popToAction` to get handled before pause
+    const timer = setTimeout(() => {
+      setPendingNavigation((pending) => {
+        if (pending?.to === focusedRouteKey) {
+          return null;
+        }
+
+        return pending;
+      });
+    }, 32);
+
+    return () => clearTimeout(timer);
   }, [descriptors, focusedRouteKey, navigation, state.index, state.routes]);
 
   const currentOptions = descriptors[state.routes[state.index].key]?.options;
@@ -265,6 +293,11 @@ export function BottomTabViewNative({
               state.routes.findIndex((r) => r.key === route.key);
 
             if (!isFocused) {
+              setPendingNavigation({
+                from: previousRouteKeyRef.current,
+                to: route.key,
+              });
+
               navigation.dispatch({
                 ...CommonActions.navigate(route.name, route.params),
                 target: state.key,
@@ -281,6 +314,7 @@ export function BottomTabViewNative({
           const {
             title,
             lazy = true,
+            inactiveBehavior = 'pause',
             tabBarLabel,
             tabBarBadgeStyle,
             tabBarIcon,
@@ -355,6 +389,15 @@ export function BottomTabViewNative({
           const icon = getIcon(false);
           const selectedIcon = getIcon(true);
 
+          // For preloaded screens and if lazy is false,
+          // Keep them active so that the effects can run
+          const isActive =
+            inactiveBehavior === 'none' ||
+            isPreloaded ||
+            pendingNavigation?.from === route.key ||
+            pendingNavigation?.to === route.key ||
+            (lazy === false && !loaded.includes(route.key));
+
           return (
             <Tabs.Screen
               onWillAppear={() => onTransitionStart({ route })}
@@ -390,6 +433,9 @@ export function BottomTabViewNative({
                     : scrollEdgeEffects?.right,
               }}
               scrollEdgeAppearance={{
+                tabBarBackgroundColor,
+                tabBarShadowColor,
+                tabBarBlurEffect,
                 stacked: {
                   normal: tabItemAppearance,
                 },
@@ -425,23 +471,38 @@ export function BottomTabViewNative({
               }
               experimental_userInterfaceStyle={dark ? 'dark' : 'light'}
             >
-              <Lazy enabled={lazy} visible={isFocused || isPreloaded}>
-                <ScreenContent
-                  isFocused={isFocused}
-                  route={route}
-                  navigation={navigation}
-                  options={options}
-                  style={sceneStyle}
+              {lazy &&
+              !loaded.includes(route.key) &&
+              !isFocused &&
+              !isPreloaded ? null : (
+                <ActivityView
+                  key={route.key}
+                  mode={isFocused ? 'normal' : isActive ? 'inert' : 'paused'}
+                  visible={
+                    // We don't need to hide the content since it's handled natively
+                    // Hiding may also cause flash due to lag after native tab switch
+                    // So we leave it always visible
+                    true
+                  }
+                  style={StyleSheet.absoluteFill}
                 >
-                  <AnimatedScreenContent isFocused={isFocused}>
-                    <BottomTabBarHeightContext.Provider value={0}>
-                      <NavigationMetaContext.Provider value={meta}>
-                        {render()}
-                      </NavigationMetaContext.Provider>
-                    </BottomTabBarHeightContext.Provider>
-                  </AnimatedScreenContent>
-                </ScreenContent>
-              </Lazy>
+                  <ScreenContent
+                    isFocused={isFocused}
+                    route={route}
+                    navigation={navigation}
+                    options={options}
+                    style={sceneStyle}
+                  >
+                    <AnimatedScreenContent isFocused={isFocused}>
+                      <BottomTabBarHeightContext.Provider value={0}>
+                        <NavigationMetaContext.Provider value={meta}>
+                          {render()}
+                        </NavigationMetaContext.Provider>
+                      </BottomTabBarHeightContext.Provider>
+                    </AnimatedScreenContent>
+                  </ScreenContent>
+                </ActivityView>
+              )}
             </Tabs.Screen>
           );
         })}

package/src/views/TabBarIcon.tsx

@@ -18,8 +18,8 @@ export type TabBarIconProps = {
   route: Route<string>;
   variant: 'uikit' | 'material';
   size: 'compact' | 'regular';
-  badge?: string | number;
-  badgeStyle?: StyleProp<TextStyle>;
+  badge?: string | number | undefined;
+  badgeStyle?: StyleProp<TextStyle> | undefined;
   activeOpacity: number;
   inactiveOpacity: number;
   activeTintColor: ColorValue;
@@ -31,7 +31,7 @@ export type TabBarIconProps = {
         color: ColorValue;
         size: number;
       }) => BottomTabIcon | React.ReactNode);
-  allowFontScaling?: boolean;
+  allowFontScaling?: boolean | undefined;
   style: StyleProp<ViewStyle>;
 };