Skip to content

Latest commit

 

History

History
77 lines (57 loc) · 2.43 KB

README.md

File metadata and controls

77 lines (57 loc) · 2.43 KB

rn-wave-bottom-bar semantic-release Build Status Known Vulnerabilities CodeFactor

Sample

Custom animated bottom-tab-bar for react-native.

💾 Installation

yarn add rn-wave-bottom-bar

or

yarn install rn-wave-bottom-bar --save

📋 Requirements

⚒️ Usage

const Tab = createBottomTabNavigator();

const tabBarIcon = (name: string) => ({
  focused,
  color,
  size,
}: {
  focused: boolean;
  color: string; // Defines fab icon color
  size: number;
}) => <Icon name={name} size={28} color={focused ? 'white' : 'white'} />;

<NavigationContainer>
  <Tab.Navigator
    tabBarOptions={{
      activeTintColor: 'purple', // Used for the FAB background Color
    }}
    tabBar={(props) => <BottomFabBar color="purple" {...props} />}
  >
    <Tab.Screen
      options={{ tabBarIcon: tabBarIcon('aliwangwang-o1') }}
      name="Home"
      component={generateScreen('Home')}
    />
    <Tab.Screen
      name="Account"
      options={{ tabBarIcon: tabBarIcon('meh') }}
      component={generateScreen('Meh')}
    />
  </Tab.Navigator>
</NavigationContainer>;

🔧 Props

Prop Type Description
color string Bottom Bar background color
springConfig Animated.SpringConfig Spring config for the animation
tabBarProps BottomTabBarProps TabBar props passed from the Tab Component

📄 Credits

Thanks to W.Candillon for the tuto : https://www.youtube.com/watch?v=6LsLgHeX500

Initial Design : https://uimovement.com/design/tab-bar-3/

Compatibility

✅ Works well with mosts Devices and tested on iPad, IPhones, Android Devices.

✅ Support device orientation.