react-native-tab-view 3.2.1 → 3.3.2

package/src/TabBarItem.tsx

@@ -1,15 +1,17 @@
 import * as React from 'react';
 import {
   Animated,
-  StyleSheet,
-  View,
-  StyleProp,
   LayoutChangeEvent,
+  StyleProp,
+  StyleSheet,
   TextStyle,
+  View,
   ViewStyle,
 } from 'react-native';
+import useLatestCallback from 'use-latest-callback';
+
 import PlatformPressable from './PlatformPressable';
-import type { Scene, Route, NavigationState } from './types';
+import type { NavigationState, Route, Scene } from './types';
 
 export type Props<T extends Route> = {
   position: Animated.AnimatedInterpolation;
@@ -37,6 +39,7 @@ export type Props<T extends Route> = {
   onLayout?: (event: LayoutChangeEvent) => void;
   onPress: () => void;
   onLongPress: () => void;
+  defaultTabWidth?: number;
   labelStyle?: StyleProp<TextStyle>;
   style: StyleProp<ViewStyle>;
 };
@@ -44,219 +47,246 @@ export type Props<T extends Route> = {
 const DEFAULT_ACTIVE_COLOR = 'rgba(255, 255, 255, 1)';
 const DEFAULT_INACTIVE_COLOR = 'rgba(255, 255, 255, 0.7)';
 
-export default class TabBarItem<T extends Route> extends React.Component<
-  Props<T>
-> {
-  private getActiveOpacity = (
-    position: Animated.AnimatedInterpolation,
-    routes: Route[],
-    tabIndex: number
-  ) => {
-    if (routes.length > 1) {
-      const inputRange = routes.map((_, i) => i);
-
-      return position.interpolate({
-        inputRange,
-        outputRange: inputRange.map((i) => (i === tabIndex ? 1 : 0)),
-      });
-    } else {
-      return 1;
-    }
-  };
-
-  private getInactiveOpacity = (
-    position: Animated.AnimatedInterpolation,
-    routes: Route[],
-    tabIndex: number
-  ) => {
-    if (routes.length > 1) {
-      const inputRange = routes.map((_: Route, i: number) => i);
-
-      return position.interpolate({
-        inputRange,
-        outputRange: inputRange.map((i: number) => (i === tabIndex ? 0 : 1)),
-      });
-    } else {
-      return 0;
-    }
-  };
+const getActiveOpacity = (
+  position: Animated.AnimatedInterpolation,
+  routesLength: number,
+  tabIndex: number
+) => {
+  if (routesLength > 1) {
+    const inputRange = Array.from({ length: routesLength }, (_, i) => i);
 
-  render() {
-    const {
-      route,
-      position,
-      navigationState,
-      renderLabel: renderLabelCustom,
-      renderIcon,
-      renderBadge,
-      getLabelText,
-      getTestID,
-      getAccessibilityLabel,
-      getAccessible,
-      activeColor: activeColorCustom,
-      inactiveColor: inactiveColorCustom,
-      pressColor,
-      pressOpacity,
-      labelStyle,
-      style,
-      onLayout,
-      onPress,
-      onLongPress,
-    } = this.props;
-
-    const tabIndex = navigationState.routes.indexOf(route);
-    const isFocused = navigationState.index === tabIndex;
-
-    const labelColorFromStyle = StyleSheet.flatten(labelStyle || {}).color;
-
-    const activeColor =
-      activeColorCustom !== undefined
-        ? activeColorCustom
-        : typeof labelColorFromStyle === 'string'
-        ? labelColorFromStyle
-        : DEFAULT_ACTIVE_COLOR;
-    const inactiveColor =
-      inactiveColorCustom !== undefined
-        ? inactiveColorCustom
-        : typeof labelColorFromStyle === 'string'
-        ? labelColorFromStyle
-        : DEFAULT_INACTIVE_COLOR;
-
-    const activeOpacity = this.getActiveOpacity(
-      position,
-      navigationState.routes,
-      tabIndex
-    );
-    const inactiveOpacity = this.getInactiveOpacity(
-      position,
-      navigationState.routes,
-      tabIndex
-    );
+    return position.interpolate({
+      inputRange,
+      outputRange: inputRange.map((i) => (i === tabIndex ? 1 : 0)),
+    });
+  } else {
+    return 1;
+  }
+};
 
-    let icon: React.ReactNode | null = null;
-    let label: React.ReactNode | null = null;
-
-    if (renderIcon) {
-      const activeIcon = renderIcon({
-        route,
-        focused: true,
-        color: activeColor,
-      });
-      const inactiveIcon = renderIcon({
-        route,
-        focused: false,
-        color: inactiveColor,
-      });
-
-      if (inactiveIcon != null && activeIcon != null) {
-        icon = (
-          <View style={styles.icon}>
-            <Animated.View style={{ opacity: inactiveOpacity }}>
-              {inactiveIcon}
-            </Animated.View>
-            <Animated.View
-              style={[StyleSheet.absoluteFill, { opacity: activeOpacity }]}
-            >
-              {activeIcon}
-            </Animated.View>
-          </View>
-        );
-      }
-    }
+const getInactiveOpacity = (
+  position: Animated.AnimatedInterpolation,
+  routesLength: number,
+  tabIndex: number
+) => {
+  if (routesLength > 1) {
+    const inputRange = Array.from({ length: routesLength }, (_, i) => i);
+
+    return position.interpolate({
+      inputRange,
+      outputRange: inputRange.map((i: number) => (i === tabIndex ? 0 : 1)),
+    });
+  } else {
+    return 0;
+  }
+};
+
+type TabBarItemInternalProps<T extends Route> = Omit<
+  Props<T>,
+  'navigationState'
+> & {
+  isFocused: boolean;
+  index: number;
+  routesLength: number;
+};
+
+const TabBarItemInternal = <T extends Route>({
+  getAccessibilityLabel,
+  getAccessible,
+  getLabelText,
+  getTestID,
+  onLongPress,
+  onPress,
+  isFocused,
+  position,
+  route,
+  style,
+  inactiveColor: inactiveColorCustom,
+  activeColor: activeColorCustom,
+  labelStyle,
+  onLayout,
+  index: tabIndex,
+  pressColor,
+  pressOpacity,
+  renderBadge,
+  renderIcon,
+  defaultTabWidth,
+  routesLength,
+  renderLabel: renderLabelCustom,
+}: TabBarItemInternalProps<T>) => {
+  const labelColorFromStyle = StyleSheet.flatten(labelStyle || {}).color;
+
+  const activeColor =
+    activeColorCustom !== undefined
+      ? activeColorCustom
+      : typeof labelColorFromStyle === 'string'
+      ? labelColorFromStyle
+      : DEFAULT_ACTIVE_COLOR;
+  const inactiveColor =
+    inactiveColorCustom !== undefined
+      ? inactiveColorCustom
+      : typeof labelColorFromStyle === 'string'
+      ? labelColorFromStyle
+      : DEFAULT_INACTIVE_COLOR;
+
+  const activeOpacity = getActiveOpacity(position, routesLength, tabIndex);
+  const inactiveOpacity = getInactiveOpacity(position, routesLength, tabIndex);
+
+  let icon: React.ReactNode | null = null;
+  let label: React.ReactNode | null = null;
 
-    const renderLabel =
-      renderLabelCustom !== undefined
-        ? renderLabelCustom
-        : ({ route, color }: { route: T; color: string }) => {
-            const labelText = getLabelText({ route });
-
-            if (typeof labelText === 'string') {
-              return (
-                <Animated.Text
-                  style={[
-                    styles.label,
-                    icon ? { marginTop: 0 } : null,
-                    labelStyle,
-                    { color },
-                  ]}
-                >
-                  {labelText}
-                </Animated.Text>
-              );
-            }
-
-            return labelText;
-          };
-
-    if (renderLabel) {
-      const activeLabel = renderLabel({
-        route,
-        focused: true,
-        color: activeColor,
-      });
-      const inactiveLabel = renderLabel({
-        route,
-        focused: false,
-        color: inactiveColor,
-      });
-
-      label = (
-        <View>
+  if (renderIcon) {
+    const activeIcon = renderIcon({
+      route,
+      focused: true,
+      color: activeColor,
+    });
+    const inactiveIcon = renderIcon({
+      route,
+      focused: false,
+      color: inactiveColor,
+    });
+
+    if (inactiveIcon != null && activeIcon != null) {
+      icon = (
+        <View style={styles.icon}>
           <Animated.View style={{ opacity: inactiveOpacity }}>
-            {inactiveLabel}
+            {inactiveIcon}
           </Animated.View>
           <Animated.View
             style={[StyleSheet.absoluteFill, { opacity: activeOpacity }]}
           >
-            {activeLabel}
+            {activeIcon}
           </Animated.View>
         </View>
       );
     }
+  }
 
-    const tabStyle = StyleSheet.flatten(style);
-    const isWidthSet = tabStyle?.width !== undefined;
-    const tabContainerStyle: ViewStyle | null = isWidthSet ? null : { flex: 1 };
-
-    const scene = { route };
-
-    let accessibilityLabel = getAccessibilityLabel(scene);
-
-    accessibilityLabel =
-      typeof accessibilityLabel !== 'undefined'
-        ? accessibilityLabel
-        : getLabelText(scene);
-
-    const badge = renderBadge ? renderBadge(scene) : null;
-
-    return (
-      <PlatformPressable
-        android_ripple={{ borderless: true }}
-        testID={getTestID(scene)}
-        accessible={getAccessible(scene)}
-        accessibilityLabel={accessibilityLabel}
-        accessibilityRole="tab"
-        accessibilityState={{ selected: isFocused }}
-        // @ts-ignore: this is to support older React Native versions
-        accessibilityStates={isFocused ? ['selected'] : []}
-        pressColor={pressColor}
-        pressOpacity={pressOpacity}
-        delayPressIn={0}
-        onLayout={onLayout}
-        onPress={onPress}
-        onLongPress={onLongPress}
-        style={[styles.pressable, tabContainerStyle]}
-      >
-        <View pointerEvents="none" style={[styles.item, tabStyle]}>
-          {icon}
-          {label}
-          {badge != null ? <View style={styles.badge}>{badge}</View> : null}
-        </View>
-      </PlatformPressable>
+  const renderLabel =
+    renderLabelCustom !== undefined
+      ? renderLabelCustom
+      : (labelProps: { route: T; color: string }) => {
+          const labelText = getLabelText({ route: labelProps.route });
+
+          if (typeof labelText === 'string') {
+            return (
+              <Animated.Text
+                style={[
+                  styles.label,
+                  icon ? { marginTop: 0 } : null,
+                  labelStyle,
+                  { color: labelProps.color },
+                ]}
+              >
+                {labelText}
+              </Animated.Text>
+            );
+          }
+
+          return labelText;
+        };
+
+  if (renderLabel) {
+    const activeLabel = renderLabel({
+      route,
+      focused: true,
+      color: activeColor,
+    });
+    const inactiveLabel = renderLabel({
+      route,
+      focused: false,
+      color: inactiveColor,
+    });
+
+    label = (
+      <View>
+        <Animated.View style={{ opacity: inactiveOpacity }}>
+          {inactiveLabel}
+        </Animated.View>
+        <Animated.View
+          style={[StyleSheet.absoluteFill, { opacity: activeOpacity }]}
+        >
+          {activeLabel}
+        </Animated.View>
+      </View>
     );
   }
+
+  const tabStyle = StyleSheet.flatten(style);
+  const isWidthSet = tabStyle?.width !== undefined;
+
+  const tabContainerStyle: ViewStyle | null = isWidthSet
+    ? null
+    : { width: defaultTabWidth };
+
+  const scene = { route };
+
+  let accessibilityLabel = getAccessibilityLabel(scene);
+
+  accessibilityLabel =
+    typeof accessibilityLabel !== 'undefined'
+      ? accessibilityLabel
+      : getLabelText(scene);
+
+  const badge = renderBadge ? renderBadge(scene) : null;
+
+  return (
+    <PlatformPressable
+      android_ripple={{ borderless: true }}
+      testID={getTestID(scene)}
+      accessible={getAccessible(scene)}
+      accessibilityLabel={accessibilityLabel}
+      accessibilityRole="tab"
+      accessibilityState={{ selected: isFocused }}
+      // @ts-ignore: this is to support older React Native versions
+      accessibilityStates={isFocused ? ['selected'] : []}
+      pressColor={pressColor}
+      pressOpacity={pressOpacity}
+      delayPressIn={0}
+      onLayout={onLayout}
+      onPress={onPress}
+      onLongPress={onLongPress}
+      style={[styles.pressable, tabContainerStyle]}
+    >
+      <View pointerEvents="none" style={[styles.item, tabStyle]}>
+        {icon}
+        {label}
+        {badge != null ? <View style={styles.badge}>{badge}</View> : null}
+      </View>
+    </PlatformPressable>
+  );
+};
+
+const MemoizedTabBarItemInternal = React.memo(
+  TabBarItemInternal
+) as typeof TabBarItemInternal;
+
+function TabBarItem<T extends Route>(props: Props<T>) {
+  const { onPress, onLongPress, onLayout, navigationState, route, ...rest } =
+    props;
+  const onPressLatest = useLatestCallback(onPress);
+  const onLongPressLatest = useLatestCallback(onLongPress);
+  const onLayoutLatest = useLatestCallback(onLayout ? onLayout : () => {});
+
+  const tabIndex = navigationState.routes.indexOf(route);
+
+  return (
+    <MemoizedTabBarItemInternal
+      {...rest}
+      onPress={onPressLatest}
+      onLayout={onLayoutLatest}
+      onLongPress={onLongPressLatest}
+      isFocused={navigationState.index === tabIndex}
+      route={route}
+      index={tabIndex}
+      routesLength={navigationState.routes.length}
+    />
+  );
 }
 
+export default TabBarItem;
+
 const styles = StyleSheet.create({
   label: {
     margin: 4,

package/src/TabView.tsx

@@ -1,20 +1,21 @@
 import * as React from 'react';
 import {
+  LayoutChangeEvent,
+  StyleProp,
   StyleSheet,
   View,
-  StyleProp,
   ViewStyle,
-  LayoutChangeEvent,
 } from 'react-native';
-import TabBar from './TabBar';
-import SceneView from './SceneView';
+
 import Pager from './Pager';
+import SceneView from './SceneView';
+import TabBar from './TabBar';
 import type {
   Layout,
   NavigationState,
+  PagerProps,
   Route,
   SceneRendererProps,
-  PagerProps,
 } from './types';
 
 export type Props<T extends Route> = PagerProps & {

package/src/index.tsx

@@ -1,15 +1,10 @@
-export { default as TabBar } from './TabBar';
+export { default as SceneMap } from './SceneMap';
 export type { Props as TabBarProps } from './TabBar';
-
-export { default as TabView } from './TabView';
-export type { Props as TabViewProps } from './TabView';
-
-export { default as TabBarIndicator } from './TabBarIndicator';
+export { default as TabBar } from './TabBar';
 export type { Props as TabBarIndicatorProps } from './TabBarIndicator';
-
-export { default as TabBarItem } from './TabBarItem';
+export { default as TabBarIndicator } from './TabBarIndicator';
 export type { Props as TabBarItemProps } from './TabBarItem';
-
-export { default as SceneMap } from './SceneMap';
-
-export type { Route, NavigationState, SceneRendererProps } from './types';
+export { default as TabBarItem } from './TabBarItem';
+export type { Props as TabViewProps } from './TabView';
+export { default as TabView } from './TabView';
+export type { NavigationState, Route, SceneRendererProps } from './types';

package/lib/typescript/SceneView.d.ts

@@ -1,32 +0,0 @@
-import * as React from 'react';
-import { StyleProp, ViewStyle } from 'react-native';
-import type { SceneRendererProps, EventEmitterProps, NavigationState, Route } from './types';
-declare type Props<T extends Route> = SceneRendererProps & EventEmitterProps & {
-    navigationState: NavigationState<T>;
-    lazy: boolean;
-    lazyPreloadDistance: number;
-    index: number;
-    children: (props: {
-        loading: boolean;
-    }) => React.ReactNode;
-    style?: StyleProp<ViewStyle>;
-};
-declare type State = {
-    loading: boolean;
-};
-export default class SceneView<T extends Route> extends React.Component<Props<T>, State> {
-    static getDerivedStateFromProps(props: Props<Route>, state: State): {
-        loading: boolean;
-    } | null;
-    state: {
-        loading: boolean;
-    };
-    componentDidMount(): void;
-    componentDidUpdate(prevProps: Props<T>, prevState: State): void;
-    componentWillUnmount(): void;
-    private timerHandler;
-    private unsubscribe;
-    private handleEnter;
-    render(): JSX.Element;
-}
-export {};

package/lib/typescript/TabBar.d.ts

@@ -1,72 +0,0 @@
-import * as React from 'react';
-import { StyleProp, ViewStyle, TextStyle } from 'react-native';
-import { Props as TabBarItemProps } from './TabBarItem';
-import { Props as IndicatorProps } from './TabBarIndicator';
-import type { Route, Scene, SceneRendererProps, NavigationState, Layout, Event } from './types';
-export declare type Props<T extends Route> = SceneRendererProps & {
-    navigationState: NavigationState<T>;
-    scrollEnabled?: boolean;
-    bounces?: boolean;
-    activeColor?: string;
-    inactiveColor?: string;
-    pressColor?: string;
-    pressOpacity?: number;
-    getLabelText: (scene: Scene<T>) => string | undefined;
-    getAccessible: (scene: Scene<T>) => boolean | undefined;
-    getAccessibilityLabel: (scene: Scene<T>) => string | undefined;
-    getTestID: (scene: Scene<T>) => string | undefined;
-    renderLabel?: (scene: Scene<T> & {
-        focused: boolean;
-        color: string;
-    }) => React.ReactNode;
-    renderIcon?: (scene: Scene<T> & {
-        focused: boolean;
-        color: string;
-    }) => React.ReactNode;
-    renderBadge?: (scene: Scene<T>) => React.ReactNode;
-    renderIndicator: (props: IndicatorProps<T>) => React.ReactNode;
-    renderTabBarItem?: (props: TabBarItemProps<T> & {
-        key: string;
-    }) => React.ReactElement;
-    onTabPress?: (scene: Scene<T> & Event) => void;
-    onTabLongPress?: (scene: Scene<T>) => void;
-    tabStyle?: StyleProp<ViewStyle>;
-    indicatorStyle?: StyleProp<ViewStyle>;
-    indicatorContainerStyle?: StyleProp<ViewStyle>;
-    labelStyle?: StyleProp<TextStyle>;
-    contentContainerStyle?: StyleProp<ViewStyle>;
-    style?: StyleProp<ViewStyle>;
-    gap?: number;
-};
-declare type State = {
-    layout: Layout;
-    tabWidths: {
-        [key: string]: number;
-    };
-};
-export default class TabBar<T extends Route> extends React.Component<Props<T>, State> {
-    static defaultProps: {
-        getLabelText: ({ route }: Scene<Route>) => string | undefined;
-        getAccessible: ({ route }: Scene<Route>) => boolean;
-        getAccessibilityLabel: ({ route }: Scene<Route>) => string | undefined;
-        getTestID: ({ route }: Scene<Route>) => string | undefined;
-        renderIndicator: (props: IndicatorProps<Route>) => JSX.Element;
-        gap: number;
-    };
-    state: State;
-    componentDidUpdate(prevProps: Props<T>, prevState: State): void;
-    private measuredTabWidths;
-    private scrollAmount;
-    private flatListRef;
-    private getFlattenedTabWidth;
-    private getComputedTabWidth;
-    private getMaxScrollDistance;
-    private getTabBarWidth;
-    private normalizeScrollValue;
-    private getScrollAmount;
-    private resetScroll;
-    private handleLayout;
-    private getTranslateX;
-    render(): JSX.Element;
-}
-export {};

package/lib/typescript/TabBarIndicator.d.ts

@@ -1,20 +0,0 @@
-import * as React from 'react';
-import { StyleProp, ViewStyle } from 'react-native';
-import type { Route, SceneRendererProps, NavigationState } from './types';
-export declare type GetTabWidth = (index: number) => number;
-export declare type Props<T extends Route> = SceneRendererProps & {
-    navigationState: NavigationState<T>;
-    width: string | number;
-    style?: StyleProp<ViewStyle>;
-    getTabWidth: GetTabWidth;
-    gap?: number;
-};
-export default class TabBarIndicator<T extends Route> extends React.Component<Props<T>> {
-    componentDidMount(): void;
-    componentDidUpdate(): void;
-    private fadeInIndicator;
-    private isIndicatorShown;
-    private opacity;
-    private getTranslateX;
-    render(): JSX.Element;
-}