Merge pull request #5 from okwasniewski/feat/new-api

feat: introduce new API

Author: okwasniewski

README.md

@@ -21,28 +21,33 @@ yarn add react-native-bottom-tabs
 
 
 ```tsx
-import { TabView } from "react-native-bottom-tabs";
-
-const items: TabViewItems = [
-  { key: 'article', title: 'Article', icon: 'document.fill' },
-  { key: 'albums', title: 'Albums', icon: 'square.grid.2x2.fill', badge: '3' },
-  { key: 'contacts', title: 'Contacts', icon: 'person.fill' },
-];
-
-export default function App() {
-  const [selectedPage, setSelectedTab] = useState<string>('contacts');
+import TabView, { SceneMap } from 'react-native-bottom-tabs';
+
+export default function ThreeTabs() {
+  const [index, setIndex] = useState(0);
+  const [routes] = useState([
+    { key: 'article', title: 'Article', icon: 'document.fill', badge: '!' },
+    {
+      key: 'albums',
+      title: 'Albums',
+      icon: 'square.grid.2x2.fill',
+      badge: '5',
+    },
+    { key: 'contacts', title: 'Contacts', icon: 'person.fill' },
+  ]);
+
+  const renderScene = SceneMap({
+    article: Article,
+    albums: Albums,
+    contacts: Contacts,
+  });
 
   return (
     <TabView
-      style={styles.fullWidth}
-      items={items}
-      selectedPage={selectedPage}
-      onPageSelected={handlePageSelected}
-    >
-      <View/>
-      <View/>
-      <View/>
-    </TabView>
+      navigationState={{ index, routes }}
+      onIndexChange={setIndex}
+      renderScene={renderScene}
+    />
   );
 }
 ```

example/src/Examples/FourTabs.tsx

@@ -1,53 +1,36 @@
-import { StyleSheet } from 'react-native';
-import TabView, {
-  type OnPageSelectedEventData,
-  type TabViewItems,
-} from 'react-native-bottom-tabs';
+import TabView, { SceneMap } from 'react-native-bottom-tabs';
 import { useState } from 'react';
 import { Article } from '../Screens/Article';
 import { Albums } from '../Screens/Albums';
-import { Chat } from '../Screens/Chat';
 import { Contacts } from '../Screens/Contacts';
+import { Chat } from '../Screens/Chat';
 
-const items: TabViewItems = [
-  { key: 'article', title: 'Article', icon: 'document.fill', badge: '!' },
-  { key: 'albums', title: 'Albums', icon: 'square.grid.2x2.fill', badge: '5' },
-  { key: 'contacts', title: 'Contacts', icon: 'person.fill' },
-  { key: 'chat', title: 'Chat', icon: 'keyboard' },
-];
-
-export default function FourTabs() {
-  const [selectedPage, setSelectedTab] = useState<string>('contacts');
-
-  const handlePageSelected = ({
-    nativeEvent: { key },
-  }: {
-    nativeEvent: OnPageSelectedEventData;
-  }) => setSelectedTab(key);
+export default function ThreeTabs() {
+  const [index, setIndex] = useState(0);
+  const [routes] = useState([
+    { key: 'article', title: 'Article', icon: 'document.fill', badge: '!' },
+    {
+      key: 'albums',
+      title: 'Albums',
+      icon: 'square.grid.2x2.fill',
+      badge: '5',
+    },
+    { key: 'contacts', title: 'Contacts', icon: 'person.fill' },
+    { key: 'chat', title: 'Chat', icon: 'keyboard' },
+  ]);
 
-  const goToAlbums = () => {
-    setSelectedTab('albums');
-  };
+  const renderScene = SceneMap({
+    article: Article,
+    albums: Albums,
+    contacts: Contacts,
+    chat: Chat,
+  });
 
   return (
     <TabView
-      style={styles.fullWidth}
-      items={items}
-      tabViewStyle="sidebarAdaptable"
-      selectedPage={selectedPage}
-      onPageSelected={handlePageSelected}
-    >
-      <Article onClick={goToAlbums} />
-      <Albums />
-      <Contacts />
-      <Chat />
-    </TabView>
+      navigationState={{ index, routes }}
+      onIndexChange={setIndex}
+      renderScene={renderScene}
+    />
   );
 }
-
-const styles = StyleSheet.create({
-  fullWidth: {
-    width: '100%',
-    height: '100%',
-  },
-});

example/src/Examples/ThreeTabs.tsx

@@ -1,50 +1,33 @@
-import { StyleSheet } from 'react-native';
-import TabView, {
-  type OnPageSelectedEventData,
-  type TabViewItems,
-} from 'react-native-bottom-tabs';
+import TabView, { SceneMap } from 'react-native-bottom-tabs';
 import { useState } from 'react';
 import { Article } from '../Screens/Article';
 import { Albums } from '../Screens/Albums';
 import { Contacts } from '../Screens/Contacts';
 
-const items: TabViewItems = [
-  { key: 'article', title: 'Article', icon: 'document.fill', badge: '!' },
-  { key: 'albums', title: 'Albums', icon: 'square.grid.2x2.fill', badge: '5' },
-  { key: 'contacts', title: 'Contacts', icon: 'person.fill' },
-];
-
 export default function ThreeTabs() {
-  const [selectedPage, setSelectedTab] = useState<string>('contacts');
-
-  const handlePageSelected = ({
-    nativeEvent: { key },
-  }: {
-    nativeEvent: OnPageSelectedEventData;
-  }) => setSelectedTab(key);
+  const [index, setIndex] = useState(0);
+  const [routes] = useState([
+    { key: 'article', title: 'Article', icon: 'document.fill', badge: '!' },
+    {
+      key: 'albums',
+      title: 'Albums',
+      icon: 'square.grid.2x2.fill',
+      badge: '5',
+    },
+    { key: 'contacts', title: 'Contacts', icon: 'person.fill' },
+  ]);
 
-  const goToAlbums = () => {
-    setSelectedTab('albums');
-  };
+  const renderScene = SceneMap({
+    article: Article,
+    albums: Albums,
+    contacts: Contacts,
+  });
 
   return (
     <TabView
-      style={styles.fullWidth}
-      items={items}
-      tabViewStyle="sidebarAdaptable"
-      selectedPage={selectedPage}
-      onPageSelected={handlePageSelected}
-    >
-      <Article onClick={goToAlbums} />
-      <Albums />
-      <Contacts />
-    </TabView>
+      navigationState={{ index, routes }}
+      onIndexChange={setIndex}
+      renderScene={renderScene}
+    />
   );
 }
-
-const styles = StyleSheet.create({
-  fullWidth: {
-    width: '100%',
-    height: '100%',
-  },
-});

example/src/Screens/Article.tsx

@@ -13,7 +13,7 @@ import {
 
 type Props = Partial<ScrollViewProps> & {
   date?: string;
-  onClick?: () => void;
+  jumpTo?: (key: string) => void;
   author?: {
     name: string;
   };
@@ -42,7 +42,7 @@ const DEFAULT_AUTHOR = {
 export function Article({
   date = '1st Jan 2025',
   author = DEFAULT_AUTHOR,
-  onClick,
+  jumpTo,
   ...rest
 }: Props) {
   const ref = React.useRef<ScrollView>(null);
@@ -65,7 +65,12 @@ export function Article({
           <Text style={[styles.timestamp, { color: '#000' }]}>{date}</Text>
         </View>
       </View>
-      <Button title="Go to Albums" onPress={onClick} />
+      <Button
+        title="Go to Albums"
+        onPress={() => {
+          jumpTo?.('albums');
+        }}
+      />
       <Heading>What is Lorem Ipsum?</Heading>
       <Paragraph>
         Lorem Ipsum is simply dummy text of the printing and typesetting

package.json

@@ -195,5 +195,8 @@
   "create-react-native-library": {
     "type": "view-mixed",
     "version": "0.41.2"
+  },
+  "dependencies": {
+    "use-latest-callback": "^0.2.1"
   }
 }

src/SceneMap.tsx

@@ -0,0 +1,34 @@
+import * as React from 'react';
+
+type SceneProps = {
+  route: any;
+  jumpTo: (key: string) => void;
+};
+
+const SceneComponent = React.memo(
+  <T extends { component: React.ComponentType<any> } & SceneProps>({
+    component,
+    ...rest
+  }: T) => {
+    return React.createElement(component, rest);
+  }
+);
+
+SceneComponent.displayName = 'SceneComponent';
+
+export function SceneMap<T>(scenes: { [key: string]: React.ComponentType<T> }) {
+  return ({ route, jumpTo }: SceneProps) => {
+    const component = scenes[route.key];
+    if (!component) {
+      return null;
+    }
+    return (
+      <SceneComponent
+        key={route.key}
+        jumpTo={jumpTo}
+        component={component}
+        route={route}
+      />
+    );
+  };
+}