@granite-js/react-native 1.0.30 → 1.0.32

package/src/use-back-event/useBackEvent.tsx

@@ -1,18 +1,27 @@
-import { createContext, ReactNode, useCallback, useContext, useEffect, useMemo, useRef, useState } from 'react';
+import { ReactNode, useCallback, useEffect, useMemo, useRef, useState } from 'react';
 import { useVisibility } from '../visibility';
+import {
+  BackEventActionsContext,
+  BackEventStateContext,
+  type BackEventActionsContextValue,
+  type BackEventStateContextValue,
+  type PrivateBackEventControls,
+} from './BackEventContext';
+import { useBackEventActionsContext } from './useBackEventActionsContext';
+import type { BackHandlerCallback } from './useBackHandler';
 
-export interface BackEventControls {
-  addEventListener: (...handlers: Array<() => void>) => void;
-  removeEventListener: (...handlers: Array<() => void>) => void;
-}
+export type BackEventSource = 'backButton' | 'iosSwipeGesture' | 'androidHardwareBackPress';
 
-interface PrivateBackEventControls extends BackEventControls {
-  handlersRef: Set<() => void>;
-  hasBackEvent: boolean;
-  onBack: () => void;
+export interface BackEvent {
+  source: BackEventSource;
 }
 
-const BackEventContext = createContext<PrivateBackEventControls | null>(null);
+export type BackEventHandler = () => void;
+
+export interface BackEventControls {
+  addEventListener: (...handlers: Array<BackEventHandler>) => void;
+  removeEventListener: (...handlers: Array<BackEventHandler>) => void;
+}
 
 /**
  * @component
@@ -41,7 +50,37 @@ const BackEventContext = createContext<PrivateBackEventControls | null>(null);
 export function BackEventProvider({ children }: { children: ReactNode }) {
   const backEventState = useBackEventState();
 
-  return <BackEventContext.Provider value={backEventState}>{children}</BackEventContext.Provider>;
+  const actions = useMemo((): BackEventActionsContextValue => {
+    return {
+      addEventListener: backEventState.addEventListener,
+      removeEventListener: backEventState.removeEventListener,
+      addBackHandler: backEventState.addBackHandler,
+      removeBackHandler: backEventState.removeBackHandler,
+      onBack: backEventState.onBack,
+      onBackHandler: backEventState.onBackHandler,
+    };
+  }, [
+    backEventState.addBackHandler,
+    backEventState.addEventListener,
+    backEventState.onBack,
+    backEventState.onBackHandler,
+    backEventState.removeBackHandler,
+    backEventState.removeEventListener,
+  ]);
+
+  const state = useMemo((): BackEventStateContextValue => {
+    return {
+      handlersRef: backEventState.handlersRef,
+      hasBackEvent: backEventState.hasBackEvent,
+      hasBackHandler: backEventState.hasBackHandler,
+    };
+  }, [backEventState.handlersRef, backEventState.hasBackEvent, backEventState.hasBackHandler]);
+
+  return (
+    <BackEventActionsContext.Provider value={actions}>
+      <BackEventStateContext.Provider value={state}>{children}</BackEventStateContext.Provider>
+    </BackEventActionsContext.Provider>
+  );
 }
 
 /**
@@ -70,11 +109,26 @@ export function BackEventProvider({ children }: { children: ReactNode }) {
  * ```
  */
 export function useBackEventState() {
-  const handlersRef = useRef<Set<() => void>>(new Set()).current;
+  const handlersRef = useRef<Set<BackEventHandler>>(new Set()).current;
+  const backHandlersRef = useRef<Set<BackHandlerCallback>>(new Set()).current;
   const [hasBackEvent, setHasBackEvent] = useState(false);
+  const [hasBackHandler, setHasBackHandler] = useState(false);
+
+  const removeEventListener = useCallback(
+    (...handlers: Array<BackEventHandler>) => {
+      for (const handler of handlers) {
+        handlersRef.delete(handler);
+      }
+
+      if (handlersRef.size === 0) {
+        setHasBackEvent(false);
+      }
+    },
+    [handlersRef]
+  );
 
   const addEventListener = useCallback(
-    (...handlers: Array<() => void>) => {
+    (...handlers: Array<BackEventHandler>) => {
       for (const handler of handlers) {
         handlersRef.add(handler);
       }
@@ -86,17 +140,53 @@ export function useBackEventState() {
     [handlersRef]
   );
 
-  const removeEventListener = useCallback(
-    (...handlers: Array<() => void>) => {
+  const removeBackHandler = useCallback(
+    (...handlers: Array<BackHandlerCallback>) => {
       for (const handler of handlers) {
-        handlersRef.delete(handler);
+        backHandlersRef.delete(handler);
       }
 
-      if (handlersRef.size === 0) {
-        setHasBackEvent(false);
+      if (backHandlersRef.size === 0) {
+        setHasBackHandler(false);
       }
     },
-    [handlersRef]
+    [backHandlersRef]
+  );
+
+  const addBackHandler = useCallback(
+    (handler: BackHandlerCallback) => {
+      backHandlersRef.add(handler);
+
+      if (backHandlersRef.size > 0) {
+        setHasBackHandler(true);
+      }
+
+      return {
+        remove: () => removeBackHandler(handler),
+      };
+    },
+    [backHandlersRef, removeBackHandler]
+  );
+
+  const onBack = useCallback(() => {
+    handlersRef.forEach((handler) => handler());
+  }, [handlersRef]);
+
+  const onBackHandler = useCallback(
+    (event: BackEvent) => {
+      const orderedBackHandlers = Array.from(backHandlersRef).reverse();
+
+      for (const handler of orderedBackHandlers) {
+        const didHandleBackEvent = handler(event) === true;
+
+        if (didHandleBackEvent) {
+          return true;
+        }
+      }
+
+      return false;
+    },
+    [backHandlersRef]
   );
 
   const backEvent = useMemo((): PrivateBackEventControls => {
@@ -105,11 +195,24 @@ export function useBackEventState() {
       removeEventListener,
       handlersRef,
       hasBackEvent,
-      onBack: () => {
-        handlersRef.forEach((handler) => handler());
-      },
+      hasBackHandler,
+      addBackHandler,
+      removeBackHandler,
+      onBack,
+      onBackHandler,
     };
-  }, [addEventListener, handlersRef, hasBackEvent, removeEventListener]);
+  }, [
+    addEventListener,
+    addBackHandler,
+    backHandlersRef,
+    handlersRef,
+    hasBackEvent,
+    hasBackHandler,
+    onBack,
+    onBackHandler,
+    removeBackHandler,
+    removeEventListener,
+  ]);
 
   return backEvent;
 }
@@ -180,36 +283,32 @@ export function useBackEventState() {
  * ```
  */
 export function useBackEvent() {
-  const context = useContext(BackEventContext);
-  const handlersRef = useRef<Set<() => void>>(new Set()).current;
+  const context = useBackEventActionsContext();
+  const handlersRef = useRef<Set<BackEventHandler>>(new Set()).current;
 
   const isVisible = useVisibility();
 
-  if (context == null) {
-    throw new Error('useBackEvent must be used within a BackEventProvider');
-  }
-
   const contextAddEventListener = context.addEventListener;
   const contextRemoveEventListener = context.removeEventListener;
 
-  const addEventListener = useCallback(
-    (...handlers: Array<() => void>) => {
+  const removeEventListener = useCallback(
+    (...handlers: Array<BackEventHandler>) => {
       for (const handler of handlers) {
-        handlersRef.add(handler);
-        contextAddEventListener(handler);
+        handlersRef.delete(handler);
+        contextRemoveEventListener(handler);
       }
     },
-    [contextAddEventListener, handlersRef]
+    [contextRemoveEventListener, handlersRef]
   );
 
-  const removeEventListener = useCallback(
-    (...handlers: Array<() => void>) => {
+  const addEventListener = useCallback(
+    (...handlers: Array<BackEventHandler>) => {
       for (const handler of handlers) {
-        handlersRef.delete(handler);
-        contextRemoveEventListener(handler);
+        handlersRef.add(handler);
+        contextAddEventListener(handler);
       }
     },
-    [contextRemoveEventListener, handlersRef]
+    [contextAddEventListener, handlersRef]
   );
 
   /**
@@ -242,12 +341,3 @@ export function useBackEvent() {
 
   return backEvent;
 }
-
-export function useBackEventContext() {
-  const context = useContext(BackEventContext);
-  if (context == null) {
-    throw new Error('useBackEvent must be used within a BackEventProvider');
-  }
-
-  return context;
-}

package/src/use-back-event/useBackEventActionsContext.ts

@@ -0,0 +1,11 @@
+import { useContext } from 'react';
+import { BackEventActionsContext } from './BackEventContext';
+
+export function useBackEventActionsContext() {
+  const context = useContext(BackEventActionsContext);
+  if (context == null) {
+    throw new Error('useBackEvent must be used within a BackEventProvider');
+  }
+
+  return context;
+}

package/src/use-back-event/useBackEventContext.ts

@@ -0,0 +1,28 @@
+import { useContext, useMemo } from 'react';
+import {
+  BackEventActionsContext,
+  BackEventStateContext,
+  type PrivateBackEventControls,
+} from './BackEventContext';
+
+export function useBackEventContext() {
+  const actions = useContext(BackEventActionsContext);
+  const state = useContext(BackEventStateContext);
+
+  const context = useMemo((): PrivateBackEventControls | null => {
+    if (actions == null || state == null) {
+      return null;
+    }
+
+    return {
+      ...actions,
+      ...state,
+    };
+  }, [actions, state]);
+
+  if (context == null) {
+    throw new Error('useBackEvent must be used within a BackEventProvider');
+  }
+
+  return context;
+}

package/src/use-back-event/useBackHandler.spec.tsx

@@ -0,0 +1,113 @@
+import { act, renderHook } from '@testing-library/react';
+import { ReactNode } from 'react';
+import { describe, expect, it, vi } from 'vitest';
+import { BackEventProvider } from './useBackEvent';
+import { useBackEventContext } from './useBackEventContext';
+import { useBackHandler } from './useBackHandler';
+
+vi.mock('../visibility', () => ({
+  useVisibility: () => true,
+}));
+
+function BackEventProviderWrapper({ children }: { children: ReactNode }) {
+  return <BackEventProvider>{children}</BackEventProvider>;
+}
+
+function useBackHandlerTest() {
+  const backHandler = useBackHandler();
+  const backEventContext = useBackEventContext();
+
+  return {
+    backHandler,
+    backEventContext,
+  };
+}
+
+describe('useBackHandler', () => {
+  it('exposes removal only through the returned subscription', () => {
+    const { result } = renderHook(() => useBackHandler(), {
+      wrapper: BackEventProviderWrapper,
+    });
+
+    expect(result.current).toEqual({
+      addEventListener: expect.any(Function),
+    });
+    expect('removeEventListener' in result.current).toBe(false);
+  });
+
+  it('bubbles from the latest handler and stops when one explicitly handles the event', () => {
+    const parent = vi.fn(() => true);
+    const child = vi.fn(() => false);
+    const overlay = vi.fn(() => true);
+    const { result } = renderHook(() => useBackHandlerTest(), {
+      wrapper: BackEventProviderWrapper,
+    });
+
+    act(() => {
+      result.current.backHandler.addEventListener(parent);
+      result.current.backHandler.addEventListener(child);
+      result.current.backHandler.addEventListener(overlay);
+    });
+
+    expect(result.current.backEventContext.onBackHandler({ source: 'iosSwipeGesture' })).toBe(true);
+    expect(overlay).toHaveBeenCalledWith({ source: 'iosSwipeGesture' });
+    expect(child).not.toHaveBeenCalled();
+    expect(parent).not.toHaveBeenCalled();
+  });
+
+  it('continues bubbling while handlers return false', () => {
+    const parent = vi.fn(() => true);
+    const child = vi.fn(() => false);
+    const { result } = renderHook(() => useBackHandlerTest(), {
+      wrapper: BackEventProviderWrapper,
+    });
+
+    act(() => {
+      result.current.backHandler.addEventListener(parent);
+      result.current.backHandler.addEventListener(child);
+    });
+
+    expect(result.current.backEventContext.onBackHandler({ source: 'backButton' })).toBe(true);
+    expect(child).toHaveBeenCalledWith({ source: 'backButton' });
+    expect(parent).toHaveBeenCalledWith({ source: 'backButton' });
+  });
+
+  it('allows default navigation when handlers return false or undefined', () => {
+    const parent = vi.fn(() => false);
+    const child = vi.fn();
+    const { result } = renderHook(() => useBackHandlerTest(), {
+      wrapper: BackEventProviderWrapper,
+    });
+
+    act(() => {
+      result.current.backHandler.addEventListener(parent);
+      result.current.backHandler.addEventListener(child);
+    });
+
+    expect(result.current.backEventContext.onBackHandler({ source: 'androidHardwareBackPress' })).toBe(false);
+    expect(child).toHaveBeenCalledWith({ source: 'androidHardwareBackPress' });
+    expect(parent).toHaveBeenCalledWith({ source: 'androidHardwareBackPress' });
+  });
+
+  it('removes a back handler through the returned subscription', () => {
+    const handler = vi.fn(() => true);
+    const { result } = renderHook(() => useBackHandlerTest(), {
+      wrapper: BackEventProviderWrapper,
+    });
+    let subscription!: ReturnType<typeof result.current.backHandler.addEventListener>;
+
+    act(() => {
+      subscription = result.current.backHandler.addEventListener(handler);
+    });
+
+    expect(result.current.backEventContext.onBackHandler({ source: 'backButton' })).toBe(true);
+
+    act(() => {
+      subscription.remove();
+    });
+
+    expect(result.current.backEventContext.hasBackHandler).toBe(false);
+    expect(result.current.backEventContext.onBackHandler({ source: 'backButton' })).toBe(false);
+    expect(handler).toHaveBeenCalledTimes(1);
+  });
+});

package/src/use-back-event/useBackHandler.tsx

@@ -0,0 +1,114 @@
+import { useCallback, useEffect, useMemo, useRef } from 'react';
+import { useVisibility } from '../visibility';
+import type { BackEvent } from './useBackEvent';
+import { useBackEventContext } from './useBackEventContext';
+
+export type BackHandlerCallback = (event: BackEvent) => boolean | void;
+
+export interface BackHandlerSubscription {
+  remove: () => void;
+}
+
+export interface BackHandlerControls {
+  addEventListener: (handler: BackHandlerCallback) => BackHandlerSubscription;
+}
+
+/**
+ * @public
+ * @category Screen Control
+ * @name useBackHandler
+ * @description
+ * A Hook that registers back handlers. Back handlers run before handlers registered through `useBackEvent`.
+ * Return `true` to stop bubbling and prevent default back navigation. Return `false` or return nothing to continue bubbling to the next handler.
+ *
+ * @example
+ *
+ * ### Example of Closing an Overlay First
+ *
+ * ```tsx
+ * import { useEffect, useState } from 'react';
+ * import { Button, View } from 'react-native';
+ * import { useBackHandler } from '@granite-js/react-native';
+ *
+ * export function OverlayExample() {
+ *   const backHandler = useBackHandler();
+ *   const [isOverlayOpen, setIsOverlayOpen] = useState(false);
+ *
+ *   useEffect(() => {
+ *     const subscription = backHandler.addEventListener(() => {
+ *       if (isOverlayOpen) {
+ *         setIsOverlayOpen(false);
+ *         return true;
+ *       }
+ *
+ *       return undefined;
+ *     });
+ *
+ *     return () => {
+ *       subscription.remove();
+ *     };
+ *   }, [backHandler, isOverlayOpen]);
+ *
+ *   return (
+ *     <View>
+ *       <Button title="Open Overlay" onPress={() => setIsOverlayOpen(true)} />
+ *     </View>
+ *   );
+ * }
+ * ```
+ */
+export function useBackHandler() {
+  const context = useBackEventContext();
+  const handlersRef = useRef<Set<BackHandlerCallback>>(new Set()).current;
+
+  const isVisible = useVisibility();
+
+  const contextAddBackHandler = context.addBackHandler;
+  const contextRemoveBackHandler = context.removeBackHandler;
+
+  const removeHandler = useCallback(
+    (...handlers: Array<BackHandlerCallback>) => {
+      for (const handler of handlers) {
+        handlersRef.delete(handler);
+        contextRemoveBackHandler(handler);
+      }
+    },
+    [contextRemoveBackHandler]
+  );
+
+  const addEventListener = useCallback(
+    (handler: BackHandlerCallback) => {
+      handlersRef.add(handler);
+      contextAddBackHandler(handler);
+
+      return {
+        remove: () => removeHandler(handler),
+      };
+    },
+    [contextAddBackHandler, removeHandler]
+  );
+
+  useEffect(() => {
+    if (!isVisible) {
+      return;
+    }
+
+    for (const handler of handlersRef) {
+      contextAddBackHandler(handler);
+    }
+
+    return () => {
+      for (const handler of handlersRef) {
+        contextRemoveBackHandler(handler);
+      }
+    };
+  }, [contextAddBackHandler, contextRemoveBackHandler, isVisible]);
+
+  const backHandler = useMemo((): BackHandlerControls => {
+    return {
+      addEventListener,
+    };
+  }, [addEventListener]);
+
+  return backHandler;
+}