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

package/src/types.tsx

@@ -223,6 +223,11 @@ export type BottomTabNavigationOptions = HeaderOptions & {
    */
   tabBarBackground?: () => React.ReactNode;
 
+  /**
+   * Position of the tab bar on the screen. Defaults to `bottom`.
+   */
+  tabBarPosition?: 'bottom' | 'left' | 'right';
+
   /**
    * Whether this screens should render the first time it's accessed. Defaults to `true`.
    * Set it to `false` if you want to render the screen on initial render.

package/src/views/BottomTabBar.tsx

@@ -1,4 +1,8 @@
-import { MissingIcon } from '@react-navigation/elements';
+import {
+  getDefaultSidebarWidth,
+  getLabel,
+  MissingIcon,
+} from '@react-navigation/elements';
 import {
   CommonActions,
   NavigationContext,
@@ -8,6 +12,7 @@ import {
   useLinkTools,
   useTheme,
 } from '@react-navigation/native';
+import Color from 'color';
 import React from 'react';
 import {
   Animated,
@@ -15,10 +20,11 @@ import {
   Platform,
   StyleProp,
   StyleSheet,
+  useWindowDimensions,
   View,
   ViewStyle,
 } from 'react-native';
-import { EdgeInsets, useSafeAreaFrame } from 'react-native-safe-area-context';
+import type { EdgeInsets } from 'react-native-safe-area-context';
 
 import type { BottomTabBarProps, BottomTabDescriptorMap } from '../types';
 import { BottomTabBarHeightCallbackContext } from '../utils/BottomTabBarHeightCallbackContext';
@@ -32,6 +38,7 @@ type Props = BottomTabBarProps & {
 const DEFAULT_TABBAR_HEIGHT = 49;
 const COMPACT_TABBAR_HEIGHT = 32;
 const DEFAULT_MAX_TAB_ITEM_WIDTH = 125;
+const SPACING = 5;
 
 const useNativeDriver = Platform.OS !== 'web';
 
@@ -140,6 +147,7 @@ export function BottomTabBar({
   const focusedOptions = focusedDescriptor.options;
 
   const {
+    tabBarPosition = 'bottom',
     tabBarShowLabel,
     tabBarHideOnKeyboard = false,
     tabBarVisibilityAnimationConfig,
@@ -147,11 +155,17 @@ export function BottomTabBar({
     tabBarBackground,
     tabBarActiveTintColor,
     tabBarInactiveTintColor,
-    tabBarActiveBackgroundColor,
+    tabBarActiveBackgroundColor = tabBarPosition !== 'bottom'
+      ? Color(tabBarActiveTintColor ?? colors.primary)
+          .alpha(0.12)
+          .rgb()
+          .string()
+      : undefined,
     tabBarInactiveBackgroundColor,
   } = focusedOptions;
 
-  const dimensions = useSafeAreaFrame();
+  // FIXME: useSafeAreaFrame doesn't update values when window is resized on Web
+  const dimensions = useWindowDimensions();
   const isKeyboardShown = useIsKeyboardShown();
 
   const onHeightChange = React.useContext(BottomTabBarHeightCallbackContext);
@@ -256,42 +270,67 @@ export function BottomTabBar({
   return (
     <Animated.View
       style={[
-        styles.tabBar,
+        tabBarPosition === 'left'
+          ? styles.left
+          : tabBarPosition === 'right'
+          ? styles.right
+          : styles.bottom,
         {
           backgroundColor:
             tabBarBackgroundElement != null ? 'transparent' : colors.card,
-          borderTopColor: colors.border,
+          borderColor: colors.border,
         },
-        {
-          transform: [
-            {
-              translateY: visible.interpolate({
-                inputRange: [0, 1],
-                outputRange: [
-                  layout.height + paddingBottom + StyleSheet.hairlineWidth,
-                  0,
+        tabBarPosition === 'bottom'
+          ? [
+              {
+                transform: [
+                  {
+                    translateY: visible.interpolate({
+                      inputRange: [0, 1],
+                      outputRange: [
+                        layout.height +
+                          paddingBottom +
+                          StyleSheet.hairlineWidth,
+                        0,
+                      ],
+                    }),
+                  },
                 ],
-              }),
+                // Absolutely position the tab bar so that the content is below it
+                // This is needed to avoid gap at bottom when the tab bar is hidden
+                position: isTabBarHidden ? 'absolute' : undefined,
+              },
+              {
+                height: tabBarHeight,
+                paddingBottom,
+                paddingHorizontal: Math.max(insets.left, insets.right),
+              },
+            ]
+          : {
+              paddingTop: insets.top,
+              paddingBottom: insets.bottom,
+              paddingLeft: tabBarPosition === 'left' ? insets.left : 0,
+              paddingRight: tabBarPosition === 'right' ? insets.right : 0,
+              minWidth: hasHorizontalLabels
+                ? getDefaultSidebarWidth(dimensions)
+                : 0,
             },
-          ],
-          // Absolutely position the tab bar so that the content is below it
-          // This is needed to avoid gap at bottom when the tab bar is hidden
-          position: isTabBarHidden ? 'absolute' : (null as any),
-        },
-        {
-          height: tabBarHeight,
-          paddingBottom,
-          paddingHorizontal: Math.max(insets.left, insets.right),
-        },
         tabBarStyle,
       ]}
       pointerEvents={isTabBarHidden ? 'none' : 'auto'}
-      onLayout={handleLayout}
+      onLayout={tabBarPosition === 'bottom' ? handleLayout : undefined}
     >
       <View pointerEvents="none" style={StyleSheet.absoluteFill}>
         {tabBarBackgroundElement}
       </View>
-      <View accessibilityRole="tablist" style={styles.content}>
+      <View
+        accessibilityRole="tablist"
+        style={
+          tabBarPosition === 'bottom'
+            ? styles.bottomContent
+            : styles.sideContent
+        }
+      >
         {routes.map((route, index) => {
           const focused = index === state.index;
           const { options } = descriptors[route.key];
@@ -319,11 +358,12 @@ export function BottomTabBar({
           };
 
           const label =
-            options.tabBarLabel !== undefined
+            typeof options.tabBarLabel === 'function'
               ? options.tabBarLabel
-              : options.title !== undefined
-              ? options.title
-              : route.name;
+              : getLabel(
+                  { label: options.tabBarLabel, title: options.title },
+                  route.name
+                );
 
           const accessibilityLabel =
             options.tabBarAccessibilityLabel !== undefined
@@ -366,7 +406,17 @@ export function BottomTabBar({
                   showLabel={tabBarShowLabel}
                   labelStyle={options.tabBarLabelStyle}
                   iconStyle={options.tabBarIconStyle}
-                  style={options.tabBarItemStyle}
+                  style={[
+                    tabBarPosition === 'bottom'
+                      ? styles.bottomItem
+                      : [
+                          styles.sideItem,
+                          hasHorizontalLabels
+                            ? { justifyContent: 'flex-start' }
+                            : null,
+                        ],
+                    options.tabBarItemStyle,
+                  ]}
                 />
               </NavigationRouteContext.Provider>
             </NavigationContext.Provider>
@@ -378,15 +428,40 @@ export function BottomTabBar({
 }
 
 const styles = StyleSheet.create({
-  tabBar: {
+  left: {
+    top: 0,
+    bottom: 0,
+    left: 0,
+    borderRightWidth: StyleSheet.hairlineWidth,
+  },
+  right: {
+    top: 0,
+    bottom: 0,
+    right: 0,
+    borderLeftWidth: StyleSheet.hairlineWidth,
+  },
+  bottom: {
     left: 0,
     right: 0,
     bottom: 0,
     borderTopWidth: StyleSheet.hairlineWidth,
     elevation: 8,
   },
-  content: {
+  bottomContent: {
     flex: 1,
     flexDirection: 'row',
   },
+  sideContent: {
+    flex: 1,
+    flexDirection: 'column',
+    padding: SPACING,
+  },
+  bottomItem: {
+    flex: 1,
+  },
+  sideItem: {
+    margin: SPACING,
+    padding: SPACING * 2,
+    borderRadius: 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

@@ -151,12 +151,22 @@ export function BottomTabView(props: Props) {
     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={hasTwoStates}
-        style={styles.container}
+        style={styles.screens}
       >
         {routes.map((route, index) => {
           const descriptor = descriptors[route.key];
@@ -218,7 +228,9 @@ export function BottomTabView(props: Props) {
               enabled={detachInactiveScreens}
               freezeOnBlur={freezeOnBlur}
             >
-              <BottomTabBarHeightContext.Provider value={tabBarHeight}>
+              <BottomTabBarHeightContext.Provider
+                value={tabBarPosition === 'bottom' ? tabBarHeight : 0}
+              >
                 <Screen
                   focused={isFocused}
                   route={descriptor.route}
@@ -250,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/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,
   },
 });