feat(events): add BottomTabPressed event

Author: aschenkel

src/index.test.ts

@@ -25,6 +25,7 @@ import {
   useNavigationModalDismiss,
   useNavigationScreenPop,
   useNavigationBottomTabSelect,
+  useNavigationBottomTabPress,
   useNavigationBottomTabLongPress,
   useNavigationButtonPress,
   useNavigationSearchBarUpdate,
@@ -770,6 +771,68 @@ describe('useNavigationBottomTabSelect', () => {
   })
 })
 
+describe('useNavigationBottomTabPress', () => {
+  let triggerEvent: (event: BottomTabLongPressedEvent) => void
+  let mockRemoveSubscription: () => void
+  let mockHandler: () => void
+
+  beforeEach(() => {
+    mockHandler = jest.fn(() => {})
+    mockRemoveSubscription = jest.fn()
+
+    Navigation.events = jest.fn().mockReturnValue({
+      registerBottomTabPressedListener: jest.fn(callback => {
+        triggerEvent = callback
+
+        return { remove: mockRemoveSubscription }
+      }),
+    })
+  })
+
+  it('should remove the event listener on unmount', () => {
+    const { result, unmount } = renderHook(() => {
+      useNavigationBottomTabPress(() => {})
+    })
+
+    unmount()
+
+    expect(mockRemoveSubscription).toBeCalledTimes(1)
+
+    expect(result.current).toBeUndefined()
+    expect(result.error).toBeUndefined()
+  })
+
+  it('should never call the handler if no event was triggered', () => {
+    const { result } = renderHook(() => {
+      useNavigationBottomTabPress(() => {})
+    })
+
+    expect(mockHandler).toBeCalledTimes(0)
+
+    expect(result.current).toBeUndefined()
+    expect(result.error).toBeUndefined()
+  })
+
+  it('should call handler twice', () => {
+    const { result } = renderHook(() => {
+      useNavigationBottomTabPress(mockHandler)
+    })
+
+    const event1 = { selectedTabIndex: 1 }
+    triggerEvent(event1)
+
+    const event2 = { selectedTabIndex: 1 }
+    triggerEvent(event2)
+
+    expect(mockHandler).toBeCalledTimes(2)
+    expect(mockHandler).toHaveBeenNthCalledWith(1, event1)
+    expect(mockHandler).toHaveBeenNthCalledWith(2, event2)
+
+    expect(result.current).toBeUndefined()
+    expect(result.error).toBeUndefined()
+  })
+})
+
 describe('useNavigationBottomTabLongPress', () => {
   let triggerEvent: (event: BottomTabLongPressedEvent) => void
   let mockRemoveSubscription: () => void

src/index.ts

@@ -8,6 +8,7 @@ import {
   ModalDismissedEvent,
   ScreenPoppedEvent,
   BottomTabSelectedEvent,
+  BottomTabPressedEvent,
   BottomTabLongPressedEvent,
   NavigationButtonPressedEvent,
   SearchBarUpdatedEvent,
@@ -141,6 +142,14 @@ function useNavigationBottomTabSelect(handler: (event: BottomTabSelectedEvent) =
   }, [handler])
 }
 
+function useNavigationBottomTabPress(handler: (event: BottomTabPressedEvent) => void) {
+  useLayoutEffect(() => {
+    const subscription = Navigation.events().registerBottomTabPressedListener(handler)
+
+    return () => subscription.remove()
+  }, [handler])
+}
+
 function useNavigationBottomTabLongPress(handler: (event: BottomTabLongPressedEvent) => void) {
   useLayoutEffect(() => {
     const subscription = Navigation.events().registerBottomTabLongPressedListener(handler)
@@ -230,6 +239,7 @@ export {
   useNavigationModalDismiss,
   useNavigationScreenPop,
   useNavigationBottomTabSelect,
+  useNavigationBottomTabPress,
   useNavigationBottomTabLongPress,
   useNavigationButtonPress,
   useNavigationSearchBarUpdate,