feat: support hiding tabs (#111)

Author: okwasniewski

android/src/main/java/com/rcttabview/RCTTabView.kt

@@ -92,6 +92,7 @@ class ReactBottomNavigationView(context: Context) : BottomNavigationView(context
     this.items = items
     items.forEachIndexed { index, item ->
       val menuItem = getOrCreateItem(index, item.title)
+      menuItem.isVisible = !item.hidden
       if (icons.containsKey(index)) {
         menuItem.icon = getDrawable(icons[index]!!)
       }

android/src/main/java/com/rcttabview/RCTTabViewImpl.kt

@@ -12,7 +12,8 @@ data class TabInfo(
   val key: String,
   val title: String,
   val badge: String,
-  val activeTintColor: Int?
+  val activeTintColor: Int?,
+  val hidden: Boolean,
 )
 
 class RCTTabViewImpl {
@@ -29,7 +30,8 @@ class RCTTabViewImpl {
             key = item.getString("key") ?: "",
             title = item.getString("title") ?: "",
             badge = item.getString("badge") ?: "",
-            activeTintColor = if (item.hasKey("activeTintColor")) item.getInt("activeTintColor") else null
+            activeTintColor = if (item.hasKey("activeTintColor")) item.getInt("activeTintColor") else null,
+            hidden = if (item.hasKey("hidden")) item.getBoolean("hidden") else false
           )
         )
       }

docs/docs/docs/guides/standalone-usage.md

@@ -200,4 +200,12 @@ Function to get the active tint color for a tab.
 #### `getIcon`
 
 Function to get the icon for a tab.
+
 - Default: Uses `route.focusedIcon` and `route.unfocusedIcon`
+
+
+#### `getHidden`
+
+Function to determine if a tab should be hidden.
+
+- Default: Uses `route.hidden`

docs/docs/docs/guides/usage-with-react-navigation.mdx

@@ -193,6 +193,16 @@ SF Symbols are only supported on Apple platforms.
 
 Badge to show on the tab icon.
 
+#### `tabBarItemHidden`
+
+Whether the tab bar item is hidden.
+
+:::warning
+
+Due to native limitations on iOS, this option doesn't hide the tab item **when hidden route is focused**.
+
+:::
+
 #### `lazy`
 
 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.

example/src/App.tsx

@@ -37,6 +37,10 @@ const FourTabsIgnoreSafeArea = () => {
   return <FourTabs ignoresTopSafeArea />;
 };
 
+const HiddenTab = () => {
+  return <FourTabs hideOneTab />;
+};
+
 const FourTabsRippleColor = () => {
   return <FourTabs rippleColor={'#00ff00'} />;
 };
@@ -114,6 +118,10 @@ const examples = [
     component: FourTabsActiveIndicatorColor,
     name: 'Four Tabs - Active Indicator color',
   },
+  {
+    component: HiddenTab,
+    name: 'Four Tabs - With Hidden Tab',
+  },
   {
     component: NativeBottomTabsVectorIcons,
     name: 'Native Bottom Tabs with Vector Icons',

example/src/Examples/FourTabs.tsx

@@ -12,6 +12,7 @@ interface Props {
   scrollEdgeAppearance?: 'default' | 'opaque' | 'transparent';
   barTintColor?: ColorValue;
   translucent?: boolean;
+  hideOneTab?: boolean;
   rippleColor?: ColorValue;
   activeIndicatorColor?: ColorValue;
 }
@@ -22,6 +23,7 @@ export default function FourTabs({
   scrollEdgeAppearance = 'default',
   barTintColor,
   translucent = true,
+  hideOneTab = false,
   rippleColor,
   activeIndicatorColor,
 }: Props) {
@@ -39,6 +41,7 @@ export default function FourTabs({
       title: 'Albums',
       focusedIcon: require('../../assets/icons/grid_dark.png'),
       badge: '5',
+      hidden: hideOneTab,
     },
     {
       key: 'contacts',

example/src/Examples/NativeBottomTabsVectorIcons.tsx

@@ -69,6 +69,7 @@ function NativeBottomTabsVectorIcons() {
         options={{
           tabBarIcon: () => messageIcon,
           tabBarActiveTintColor: 'white',
+          tabBarItemHidden: true,
         }}
       />
     </Tab.Navigator>

ios/Fabric/RCTTabViewComponentView.mm

@@ -155,7 +155,8 @@ bool areTabItemsEqual(const RNCTabViewItemsStruct& lhs, const RNCTabViewItemsStr
   lhs.title == rhs.title &&
   lhs.sfSymbol == rhs.sfSymbol &&
   lhs.badge == rhs.badge &&
-  lhs.activeTintColor == rhs.activeTintColor;
+  lhs.activeTintColor == rhs.activeTintColor &&
+  lhs.hidden == rhs.hidden;
 }
 
 bool haveTabItemsChanged(const std::vector<RNCTabViewItemsStruct>& oldItems,
@@ -178,7 +179,7 @@ bool haveTabItemsChanged(const std::vector<RNCTabViewItemsStruct>& oldItems,
   NSMutableArray<TabInfo *> *result = [NSMutableArray array];
 
   for (const auto& item : items) {
-    auto tabInfo = [[TabInfo alloc] initWithKey:RCTNSStringFromString(item.key) title:RCTNSStringFromString(item.title) badge:RCTNSStringFromString(item.badge) sfSymbol:RCTNSStringFromString(item.sfSymbol) activeTintColor:RCTUIColorFromSharedColor(item.activeTintColor)];
+    auto tabInfo = [[TabInfo alloc] initWithKey:RCTNSStringFromString(item.key) title:RCTNSStringFromString(item.title) badge:RCTNSStringFromString(item.badge) sfSymbol:RCTNSStringFromString(item.sfSymbol) activeTintColor:RCTUIColorFromSharedColor(item.activeTintColor) hidden:item.hidden];
 
     [result addObject:tabInfo];
   }

ios/TabViewImpl.swift

@@ -56,50 +56,20 @@ struct TabViewImpl: View {
   var body: some View {
     TabView(selection: $props.selectedPage) {
       ForEach(props.children.indices, id: \.self) { index in
-        let child = props.children[safe: index] ?? UIView()
-        let tabData = props.items[safe: index]
-        let icon = props.icons[index]
-        
-        RepresentableView(view: child)
-          .ignoresTopSafeArea(
-            props.ignoresTopSafeArea ?? false,
-            frame: child.frame
-          )
-          .tabItem {
-            TabItem(
-              title: tabData?.title,
-              icon: icon,
-              sfSymbol: tabData?.sfSymbol,
-              labeled: props.labeled
-            )
-          }
-          .tag(tabData?.key)
-          .tabBadge(tabData?.badge)
-#if os(iOS)
-          .onAppear {
-            // SwiftUI doesn't change `selection` when clicked on items from the "More" list.
-            // More tab is visible only if we have more than 5 items.
-            // This is a workaround that fixes the "More" feature.
-            if index < 4 {
-              return
-            }
-            if let key = tabData?.key, props.selectedPage != key {
-              onSelect(key)
-            }
-          }
-#endif
+        renderTabItem(at: index)
       }
-      
     }
     .onTabItemEvent({ index, isLongPress in
-      if let key = props.items[safe: index]?.key {
-        if isLongPress {
-          onLongPress(key)
-          emitHapticFeedback(longPress: true)
-        } else {
-          onSelect(key)
-          emitHapticFeedback()
-        }
+      guard let key = props.items.filter({
+        !$0.hidden || $0.key == props.selectedPage
+      })[safe: index]?.key else { return }
+      
+      if isLongPress {
+        onLongPress(key)
+        emitHapticFeedback(longPress: true)
+      } else {
+        onSelect(key)
+        emitHapticFeedback()
       }
     })
     .tintColor(props.selectedActiveTintColor)
@@ -115,6 +85,42 @@ struct TabViewImpl: View {
     }
   }
 
+  @ViewBuilder
+  private func renderTabItem(at index: Int) -> some View {
+    let tabData = props.items[safe: index]
+    let isHidden = tabData?.hidden ?? false
+    let isFocused = props.selectedPage == tabData?.key
+    
+    if !isHidden || isFocused {
+      let child = props.children[safe: index] ?? UIView()
+      let icon = props.icons[index]
+      
+      RepresentableView(view: child)
+        .ignoresTopSafeArea(
+          props.ignoresTopSafeArea ?? false,
+          frame: child.frame
+        )
+        .tabItem {
+          TabItem(
+            title: tabData?.title,
+            icon: icon,
+            sfSymbol: tabData?.sfSymbol,
+            labeled: props.labeled
+          )
+        }
+        .tag(tabData?.key)
+        .tabBadge(tabData?.badge)
+#if os(iOS)
+        .onAppear {
+          guard index >= 4,
+                let key = tabData?.key,
+                props.selectedPage != key else { return }
+          onSelect(key)
+        }
+#endif
+    }
+  }
+  
   func emitHapticFeedback(longPress: Bool = false) {
 #if os(iOS)
     if !props.hapticFeedbackEnabled {

ios/TabViewProvider.swift

@@ -8,20 +8,23 @@ import React
   @objc public let badge: String
   @objc public let sfSymbol: String
   @objc public let activeTintColor: UIColor?
+  @objc public let hidden: Bool
 
   @objc
   public init(
     key: String,
     title: String,
     badge: String,
     sfSymbol: String,
-    activeTintColor: UIColor?
+    activeTintColor: UIColor?,
+    hidden: Bool
   ) {
     self.key = key
     self.title = title
     self.badge = badge
     self.sfSymbol = sfSymbol
     self.activeTintColor = activeTintColor
+    self.hidden = hidden
     super.init()
   }
 }
@@ -210,7 +213,8 @@ import React
             title: itemDict["title"] as? String ?? "",
             badge: itemDict["badge"] as? String ?? "",
             sfSymbol: itemDict["sfSymbol"] as? String ?? "",
-            activeTintColor: RCTConvert.uiColor(itemDict["activeTintColor"] as? NSNumber)
+            activeTintColor: RCTConvert.uiColor(itemDict["activeTintColor"] as? NSNumber),
+            hidden: itemDict["hidden"] as? Bool ?? false
           )
         )
       }