import color from 'color';
import * as React from 'react';
import {
Animated,
Platform,
StyleProp,
StyleSheet,
TouchableWithoutFeedback,
TouchableWithoutFeedbackProps,
View,
ViewStyle,
} from 'react-native';
import { getBottomSpace } from 'react-native-iphone-x-helper';
import { withTheme } from '../../core/theming';
import { black, white } from '../../styles/colors';
import overlay from '../../styles/overlay';
import isNativeAnimationSupported from '../../utils/isNativeAnimationSupported';
import useAnimatedValue from '../../utils/useAnimatedValue';
import useAnimatedValueArray from '../../utils/useAnimatedValueArray';
import useIsKeyboardShown from '../../utils/useIsKeyboardShown';
import useLayout from '../../utils/useLayout';
import Badge from '../Badge';
import Icon, { IconSource } from '../Icon';
import Surface from '../Surface';
import TouchableRipple from '../TouchableRipple/TouchableRipple';
import Text from '../Typography/Text';
import BottomNavigationRouteScreen from './BottomNavigationRouteScreen';
type Route = {
key: string;
title?: string;
icon?: IconSource;
badge?: string | number | boolean;
color?: string;
accessibilityLabel?: string;
testID?: string;
};
type NavigationState = {
index: number;
routes: Route[];
};
type TabPressEvent = {
defaultPrevented: boolean;
preventDefault(): void;
};
type TouchableProps = TouchableWithoutFeedbackProps & {
key: string;
route: Route;
children: React.ReactNode;
borderless?: boolean;
centered?: boolean;
rippleColor?: string;
};
type Props = {
/**
* Whether the shifting style is used, the active tab icon shifts up to show the label and the inactive tabs won't have a label.
*
* By default, this is `true` when you have more than 3 tabs.
* Pass `shifting={false}` to explicitly disable this animation, or `shifting={true}` to always use this animation.
*/
shifting?: boolean;
/**
* Whether to show labels in tabs. When `false`, only icons will be displayed.
*/
labeled?: boolean;
/**
* State for the bottom navigation. The state should contain the following properties:
*
* - `index`: a number representing the index of the active route in the `routes` array
* - `routes`: an array containing a list of route objects used for rendering the tabs
*
* Each route object should contain the following properties:
*
* - `key`: a unique key to identify the route (required)
* - `title`: title of the route to use as the tab label
* - `icon`: icon to use as the tab icon, can be a string, an image source or a react component
* - `color`: color to use as background color for shifting bottom navigation
* - `badge`: badge to show on the tab icon, can be `true` to show a dot, `string` or `number` to show text.
* - `accessibilityLabel`: accessibility label for the tab button
* - `testID`: test id for the tab button
*
* Example:
*
* ```js
* {
* index: 1,
* routes: [
* { key: 'music', title: 'Music', icon: 'queue-music', color: '#3F51B5' },
* { key: 'albums', title: 'Albums', icon: 'album', color: '#009688' },
* { key: 'recents', title: 'Recents', icon: 'history', color: '#795548' },
* { key: 'purchased', title: 'Purchased', icon: 'shopping-cart', color: '#607D8B' },
* ]
* }
* ```
*
* `BottomNavigation` is a controlled component, which means the `index` needs to be updated via the `onIndexChange` callback.
*/
navigationState: NavigationState;
/**
* Callback which is called on tab change, receives the index of the new tab as argument.
* The navigation state needs to be updated when it's called, otherwise the change is dropped.
*/
onIndexChange: (index: number) => void;
/**
* Callback which returns a react element to render as the page for the tab. Receives an object containing the route as the argument:
*
* ```js
* renderScene = ({ route, jumpTo }) => {
* switch (route.key) {
* case 'music':
* return ;
* case 'albums':
* return ;
* }
* }
* ```
*
* Pages are lazily rendered, which means that a page will be rendered the first time you navigate to it.
* After initial render, all the pages stay rendered to preserve their state.
*
* You need to make sure that your individual routes implement a `shouldComponentUpdate` to improve the performance.
* To make it easier to specify the components, you can use the `SceneMap` helper:
*
* ```js
* renderScene = BottomNavigation.SceneMap({
* music: MusicRoute,
* albums: AlbumsRoute,
* });
* ```
*
* Specifying the components this way is easier and takes care of implementing a `shouldComponentUpdate` method.
* Each component will receive the current route and a `jumpTo` method as it's props.
* The `jumpTo` method can be used to navigate to other tabs programmatically:
*
* ```js
* this.props.jumpTo('albums')
* ```
*/
renderScene: (props: {
route: Route;
jumpTo: (key: string) => void;
}) => React.ReactNode | null;
/**
* Callback which returns a React Element to be used as tab icon.
*/
renderIcon?: (props: {
route: Route;
focused: boolean;
color: string;
}) => React.ReactNode;
/**
* Callback which React Element to be used as tab label.
*/
renderLabel?: (props: {
route: Route;
focused: boolean;
color: string;
}) => React.ReactNode;
/**
* Callback which returns a React element to be used as the touchable for the tab item.
* Renders a `TouchableRipple` on Android and `TouchableWithoutFeedback` with `View` on iOS.
*/
renderTouchable?: (props: TouchableProps) => React.ReactNode;
/**
* Get label text for the tab, uses `route.title` by default. Use `renderLabel` to replace label component.
*/
getLabelText?: (props: { route: Route }) => string | undefined;
/**
* Get accessibility label for the tab button. This is read by the screen reader when the user taps the tab.
* Uses `route.accessibilityLabel` by default.
*/
getAccessibilityLabel?: (props: { route: Route }) => string | undefined;
/**
* Get the id to locate this tab button in tests, uses `route.testID` by default.
*/
getTestID?: (props: { route: Route }) => string | undefined;
/**
* Get badge for the tab, uses `route.badge` by default.
*/
getBadge?: (props: { route: Route }) => boolean | number | string | undefined;
/**
* Get color for the tab, uses `route.color` by default.
*/
getColor?: (props: { route: Route }) => string | undefined;
/**
* Function to execute on tab press. It receives the route for the pressed tab, useful for things like scroll to top.
*/
onTabPress?: (props: { route: Route } & TabPressEvent) => void;
/**
* Custom color for icon and label in the active tab.
*/
activeColor?: string;
/**
* Custom color for icon and label in the inactive tab.
*/
inactiveColor?: string;
/**
* Whether animation is enabled for scenes transitions in `shifting` mode.
* By default, the scenes cross-fade during tab change when `shifting` is enabled.
* Specify `sceneAnimationEnabled` as `false` to disable the animation.
*/
sceneAnimationEnabled?: boolean;
/**
* Whether the bottom navigation bar is hidden when keyboard is shown.
* On Android, this works best when [`windowSoftInputMode`](https://developer.android.com/guide/topics/manifest/activity-element#wsoft) is set to `adjustResize`.
*/
keyboardHidesNavigationBar?: boolean;
/**
* Safe area insets for the tab bar. This can be used to avoid elements like the navigation bar on Android and bottom safe area on iOS.
* The bottom insets for iOS is added by default. You can override the behavior with this option.
*/
safeAreaInsets?: {
top?: number;
right?: number;
bottom?: number;
left?: number;
};
/**
* Style for the bottom navigation bar. You can pass a custom background color here:
*
* ```js
* barStyle={{ backgroundColor: '#694fad' }}
* ```
*/
barStyle?: StyleProp;
/**
* Specifies the largest possible scale a label font can reach.
*/
labelMaxFontSizeMultiplier?: number;
style?: StyleProp;
/**
* @optional
*/
theme: ReactNativePaper.Theme;
};
const MIN_RIPPLE_SCALE = 0.001; // Minimum scale is not 0 due to bug with animation
const MIN_TAB_WIDTH = 96;
const MAX_TAB_WIDTH = 168;
const BAR_HEIGHT = 56;
const BOTTOM_INSET = getBottomSpace();
const FAR_FAR_AWAY = Platform.OS === 'web' ? 0 : 9999;
const Touchable = ({
route: _0,
style,
children,
borderless,
centered,
rippleColor,
...rest
}: TouchableProps) =>
TouchableRipple.supported ? (
{children}
) : (
{children}
);
const SceneComponent = React.memo(({ component, ...rest }: any) =>
React.createElement(component, rest)
);
/**
* Bottom navigation provides quick navigation between top-level views of an app with a bottom navigation bar.
* It is primarily designed for use on mobile.
*
* For integration with React Navigation, you can use [react-navigation-material-bottom-tabs](https://github.com/react-navigation/react-navigation/tree/main/packages/material-bottom-tabs) and consult [createMaterialBottomTabNavigator](https://reactnavigation.org/docs/material-bottom-tab-navigator/) documentation.
*
* By default Bottom navigation uses primary color as a background, in dark theme with `adaptive` mode it will use surface colour instead.
* See [Dark Theme](https://callstack.github.io/react-native-paper/theming.html#dark-theme) for more information.
*
*
*

*
*
* ## Usage
* ```js
* import * as React from 'react';
* import { BottomNavigation, Text } from 'react-native-paper';
*
* const MusicRoute = () => Music;
*
* const AlbumsRoute = () => Albums;
*
* const RecentsRoute = () => Recents;
*
* const MyComponent = () => {
* const [index, setIndex] = React.useState(0);
* const [routes] = React.useState([
* { key: 'music', title: 'Music', icon: 'queue-music' },
* { key: 'albums', title: 'Albums', icon: 'album' },
* { key: 'recents', title: 'Recents', icon: 'history' },
* ]);
*
* const renderScene = BottomNavigation.SceneMap({
* music: MusicRoute,
* albums: AlbumsRoute,
* recents: RecentsRoute,
* });
*
* return (
*
* );
* };
*
* export default MyComponent;
* ```
*/
const BottomNavigation = ({
navigationState,
renderScene,
renderIcon,
renderLabel,
renderTouchable = (props: TouchableProps) => ,
getLabelText = ({ route }: { route: Route }) => route.title,
getBadge = ({ route }: { route: Route }) => route.badge,
getColor = ({ route }: { route: Route }) => route.color,
getAccessibilityLabel = ({ route }: { route: Route }) =>
route.accessibilityLabel,
getTestID = ({ route }: { route: Route }) => route.testID,
activeColor,
inactiveColor,
keyboardHidesNavigationBar = true,
barStyle,
labeled = true,
style,
theme,
sceneAnimationEnabled = false,
onTabPress,
onIndexChange,
shifting = navigationState.routes.length > 3,
safeAreaInsets,
labelMaxFontSizeMultiplier = 1,
}: Props) => {
const { scale } = theme.animation;
const focusedKey = navigationState.routes[navigationState.index].key;
/**
* Visibility of the navigation bar, visible state is 1 and invisible is 0.
*/
const visibleAnim = useAnimatedValue(1);
/**
* Active state of individual tab items, active state is 1 and inactive state is 0.
*/
const tabsAnims = useAnimatedValueArray(
navigationState.routes.map(
// focused === 1, unfocused === 0
(_, i) => (i === navigationState.index ? 1 : 0)
)
);
/**
* The top offset for each tab item to position it offscreen.
* Placing items offscreen helps to save memory usage for inactive screens with removeClippedSubviews.
* We use animated values for this to prevent unnecessary re-renders.
*/
const offsetsAnims = useAnimatedValueArray(
navigationState.routes.map(
// offscreen === 1, normal === 0
(_, i) => (i === navigationState.index ? 0 : 1)
)
);
/**
* Index of the currently active tab. Used for setting the background color.
* We don't use the color as an animated value directly, because `setValue` seems to be buggy with colors.
*/
const indexAnim = useAnimatedValue(navigationState.index);
/**
* Animation for the background color ripple, used to determine it's scale and opacity.
*/
const rippleAnim = useAnimatedValue(MIN_RIPPLE_SCALE);
/**
* Layout of the navigation bar. The width is used to determine the size and position of the ripple.
*/
const [layout, onLayout] = useLayout();
/**
* List of loaded tabs, tabs will be loaded when navigated to.
*/
const [loaded, setLoaded] = React.useState([focusedKey]);
if (!loaded.includes(focusedKey)) {
// Set the current tab to be loaded if it was not loaded before
setLoaded((loaded) => [...loaded, focusedKey]);
}
/**
* Track whether the keyboard is visible to show and hide the navigation bar.
*/
const [keyboardVisible, setKeyboardVisible] = React.useState(false);
const handleKeyboardShow = React.useCallback(() => {
setKeyboardVisible(true);
Animated.timing(visibleAnim, {
toValue: 0,
duration: 150 * scale,
useNativeDriver: isNativeAnimationSupported(),
}).start();
}, [scale, visibleAnim]);
const handleKeyboardHide = React.useCallback(() => {
Animated.timing(visibleAnim, {
toValue: 1,
duration: 100 * scale,
useNativeDriver: isNativeAnimationSupported(),
}).start(() => {
setKeyboardVisible(false);
});
}, [scale, visibleAnim]);
const animateToIndex = React.useCallback(
(index: number) => {
// Reset the ripple to avoid glitch if it's currently animating
rippleAnim.setValue(MIN_RIPPLE_SCALE);
Animated.parallel([
Animated.timing(rippleAnim, {
toValue: 1,
duration: shifting ? 400 * scale : 0,
useNativeDriver: isNativeAnimationSupported(),
}),
...navigationState.routes.map((_, i) =>
Animated.timing(tabsAnims[i], {
toValue: i === index ? 1 : 0,
duration: shifting ? 150 * scale : 0,
useNativeDriver: isNativeAnimationSupported(),
})
),
]).start(({ finished }) => {
// Workaround a bug in native animations where this is reset after first animation
tabsAnims.map((tab, i) => tab.setValue(i === index ? 1 : 0));
// Update the index to change bar's background color and then hide the ripple
indexAnim.setValue(index);
rippleAnim.setValue(MIN_RIPPLE_SCALE);
if (finished) {
// Position all inactive screens offscreen to save memory usage
// Only do it when animation has finished to avoid glitches mid-transition if switching fast
offsetsAnims.forEach((offset, i) => {
if (i === index) {
offset.setValue(0);
} else {
offset.setValue(1);
}
});
}
});
},
[
indexAnim,
shifting,
navigationState.routes,
offsetsAnims,
rippleAnim,
scale,
tabsAnims,
]
);
React.useEffect(() => {
// Workaround for native animated bug in react-native@^0.57
// Context: https://github.com/callstack/react-native-paper/pull/637
animateToIndex(navigationState.index);
// eslint-disable-next-line react-hooks/exhaustive-deps
}, []);
useIsKeyboardShown({
onShow: handleKeyboardShow,
onHide: handleKeyboardHide,
});
const prevNavigationState = React.useRef();
React.useEffect(() => {
// Reset offsets of previous and current tabs before animation
offsetsAnims.forEach((offset, i) => {
if (
i === navigationState.index ||
i === prevNavigationState.current?.index
) {
offset.setValue(0);
}
});
animateToIndex(navigationState.index);
}, [navigationState.index, animateToIndex, offsetsAnims]);
const handleTabPress = (index: number) => {
const event = {
route: navigationState.routes[index],
defaultPrevented: false,
preventDefault: () => {
event.defaultPrevented = true;
},
};
onTabPress?.(event);
if (event.defaultPrevented) {
return;
}
if (index !== navigationState.index) {
onIndexChange(index);
}
};
const jumpTo = React.useCallback(
(key: string) => {
const index = navigationState.routes.findIndex(
(route) => route.key === key
);
onIndexChange(index);
},
[navigationState.routes, onIndexChange]
);
const { routes } = navigationState;
const { colors, dark: isDarkTheme, mode } = theme;
const { backgroundColor: customBackground, elevation = 4 }: ViewStyle =
StyleSheet.flatten(barStyle) || {};
const approxBackgroundColor = customBackground
? customBackground
: isDarkTheme && mode === 'adaptive'
? overlay(elevation, colors.surface)
: colors.primary;
const backgroundColor = shifting
? indexAnim.interpolate({
inputRange: routes.map((_, i) => i),
// FIXME: does outputRange support ColorValue or just strings?
// @ts-expect-error
outputRange: routes.map(
(route) => getColor({ route }) || approxBackgroundColor
),
})
: approxBackgroundColor;
const isDark =
typeof approxBackgroundColor === 'string'
? !color(approxBackgroundColor).isLight()
: true;
const textColor = isDark ? white : black;
const activeTintColor =
typeof activeColor !== 'undefined' ? activeColor : textColor;
const inactiveTintColor =
typeof inactiveColor !== 'undefined'
? inactiveColor
: color(textColor).alpha(0.5).rgb().string();
const touchColor = color(activeColor || activeTintColor)
.alpha(0.12)
.rgb()
.string();
const maxTabWidth = routes.length > 3 ? MIN_TAB_WIDTH : MAX_TAB_WIDTH;
const maxTabBarWidth = maxTabWidth * routes.length;
const tabBarWidth = Math.min(layout.width, maxTabBarWidth);
const tabWidth = tabBarWidth / routes.length;
const rippleSize = layout.width / 4;
const insets = {
left: safeAreaInsets?.left ?? 0,
right: safeAreaInsets?.right ?? 0,
bottom: safeAreaInsets?.bottom ?? BOTTOM_INSET,
};
return (
{routes.map((route, index) => {
if (!loaded.includes(route.key)) {
// Don't render a screen if we've never navigated to it
return null;
}
const focused = navigationState.index === index;
const opacity = sceneAnimationEnabled
? tabsAnims[index]
: focused
? 1
: 0;
const top = sceneAnimationEnabled
? offsetsAnims[index].interpolate({
inputRange: [0, 1],
outputRange: [0, FAR_FAR_AWAY],
})
: focused
? 0
: FAR_FAR_AWAY;
return (
{renderScene({ route, jumpTo })}
);
})}
}
pointerEvents={
layout.measured
? keyboardHidesNavigationBar && keyboardVisible
? 'none'
: 'auto'
: 'none'
}
onLayout={onLayout}
>
{shifting ? (
) : null}
{routes.map((route, index) => {
const focused = navigationState.index === index;
const active = tabsAnims[index];
// Scale the label up
const scale =
labeled && shifting
? active.interpolate({
inputRange: [0, 1],
outputRange: [0.5, 1],
})
: 1;
// Move down the icon to account for no-label in shifting and smaller label in non-shifting.
const translateY = labeled
? shifting
? active.interpolate({
inputRange: [0, 1],
outputRange: [7, 0],
})
: 0
: 7;
// We render the active icon and label on top of inactive ones and cross-fade them on change.
// This trick gives the illusion that we are animating between active and inactive colors.
// This is to ensure that we can use native driver, as colors cannot be animated with native driver.
const activeOpacity = active;
const inactiveOpacity = active.interpolate({
inputRange: [0, 1],
outputRange: [1, 0],
});
const badge = getBadge({ route });
return renderTouchable({
key: route.key,
route,
borderless: true,
centered: true,
rippleColor: touchColor,
onPress: () => handleTabPress(index),
testID: getTestID({ route }),
accessibilityLabel: getAccessibilityLabel({ route }),
// @ts-expect-error We keep old a11y props for backwards compat with old RN versions
accessibilityTraits: focused
? ['button', 'selected']
: 'button',
accessibilityComponentType: 'button',
accessibilityRole: Platform.OS === 'ios' ? 'button' : 'tab',
accessibilityState: { selected: focused },
style: styles.item,
children: (
{renderIcon ? (
renderIcon({
route,
focused: true,
color: activeTintColor,
})
) : (
)}
{renderIcon ? (
renderIcon({
route,
focused: false,
color: inactiveTintColor,
})
) : (
)}
{typeof badge === 'boolean' ? (
) : (
{badge}
)}
{labeled ? (
{renderLabel ? (
renderLabel({
route,
focused: true,
color: activeTintColor,
})
) : (
{getLabelText({ route })}
)}
{shifting ? null : (
{renderLabel ? (
renderLabel({
route,
focused: false,
color: inactiveTintColor,
})
) : (
{getLabelText({ route })}
)}
)}
) : (
)}
),
});
})}
);
};
/**
* Function which takes a map of route keys to components.
* Pure components are used to minimize re-rendering of the pages.
* This drastically improves the animation performance.
*/
BottomNavigation.SceneMap = (scenes: {
[key: string]: React.ComponentType<{
route: Route;
jumpTo: (key: string) => void;
}>;
}) => {
return ({
route,
jumpTo,
}: {
route: Route;
jumpTo: (key: string) => void;
}) => (
);
};
export default withTheme(BottomNavigation);
const styles = StyleSheet.create({
container: {
flex: 1,
overflow: 'hidden',
},
content: {
flex: 1,
},
bar: {
left: 0,
right: 0,
bottom: 0,
elevation: 4,
},
barContent: {
alignItems: 'center',
overflow: 'hidden',
},
items: {
flexDirection: 'row',
...(Platform.OS === 'web'
? {
width: '100%',
}
: null),
},
item: {
flex: 1,
// Top padding is 6 and bottom padding is 10
// The extra 4dp bottom padding is offset by label's height
paddingVertical: 6,
},
ripple: {
position: 'absolute',
},
iconContainer: {
height: 24,
width: 24,
marginTop: 2,
marginHorizontal: 12,
alignSelf: 'center',
},
iconWrapper: {
...StyleSheet.absoluteFillObject,
alignItems: 'center',
},
labelContainer: {
height: 16,
paddingBottom: 2,
},
labelWrapper: {
...StyleSheet.absoluteFillObject,
},
// eslint-disable-next-line react-native/no-color-literals
label: {
fontSize: 12,
height: BAR_HEIGHT,
textAlign: 'center',
backgroundColor: 'transparent',
...(Platform.OS === 'web'
? {
whiteSpace: 'nowrap',
alignSelf: 'center',
}
: null),
},
badgeContainer: {
position: 'absolute',
left: 0,
top: -2,
},
});