react-native-screens 3.8.0 → 3.10.2

package/src/reanimated/ReanimatedNativeStackScreen.tsx

@@ -0,0 +1,61 @@
+import React from 'react';
+import { Platform } from 'react-native';
+import {
+  Screen,
+  ScreenProps,
+  TransitionProgressEventType,
+} from 'react-native-screens';
+
+// @ts-ignore file to be used only if `react-native-reanimated` available in the project
+import Animated, { useEvent, useSharedValue } from 'react-native-reanimated';
+import ReanimatedTransitionProgressContext from './ReanimatedTransitionProgressContext';
+
+const AnimatedScreen = Animated.createAnimatedComponent(
+  (Screen as unknown) as React.ComponentClass
+);
+
+const ReanimatedNativeStackScreen = React.forwardRef<
+  typeof AnimatedScreen,
+  ScreenProps
+>((props, ref) => {
+  const { children, ...rest } = props;
+
+  const progress = useSharedValue(0);
+  const closing = useSharedValue(0);
+  const goingForward = useSharedValue(0);
+
+  return (
+    <AnimatedScreen
+      // @ts-ignore some problems with ref and onTransitionProgressReanimated being "fake" prop for parsing of `useEvent` return value
+      ref={ref}
+      onTransitionProgressReanimated={useEvent(
+        (event: TransitionProgressEventType) => {
+          'worklet';
+          progress.value = event.progress;
+          closing.value = event.closing;
+          goingForward.value = event.goingForward;
+        },
+        [
+          // This should not be necessary, but is not properly managed by `react-native-reanimated`
+          // @ts-ignore wrong type
+          Platform.OS === 'android'
+            ? 'onTransitionProgress'
+            : 'topTransitionProgress',
+        ]
+      )}
+      {...rest}>
+      <ReanimatedTransitionProgressContext.Provider
+        value={{
+          progress: progress,
+          closing: closing,
+          goingForward: goingForward,
+        }}>
+        {children}
+      </ReanimatedTransitionProgressContext.Provider>
+    </AnimatedScreen>
+  );
+});
+
+ReanimatedNativeStackScreen.displayName = 'ReanimatedNativeStackScreen';
+
+export default ReanimatedNativeStackScreen;

package/src/reanimated/ReanimatedScreen.tsx

@@ -1,103 +1,25 @@
-import React, { PropsWithChildren } from 'react';
-import { Platform, View } from 'react-native';
-import {
-  Screen,
-  ScreenProps,
-  ScreenContext,
-  TransitionProgressEventType,
-} from 'react-native-screens';
+import React from 'react';
+import { Screen, ScreenProps } from 'react-native-screens';
 
 // @ts-ignore file to be used only if `react-native-reanimated` available in the project
-import Animated, { useEvent, useSharedValue } from 'react-native-reanimated';
-import ReanimatedTransitionProgressContext from './ReanimatedTransitionProgressContext';
+import Animated from 'react-native-reanimated';
 
 const AnimatedScreen = Animated.createAnimatedComponent(
   (Screen as unknown) as React.ComponentClass
 );
 
-class ReanimatedScreenWrapper extends React.Component<ScreenProps> {
-  private ref: React.ElementRef<typeof View> | null = null;
-
-  setNativeProps(props: ScreenProps): void {
-    this.ref?.setNativeProps(props);
-  }
-
-  setRef = (ref: React.ElementRef<typeof View> | null): void => {
-    this.ref = ref;
-    this.props.onComponentRef?.(ref);
-  };
-
-  render() {
-    return (
-      <ReanimatedScreen
-        {...this.props}
-        // @ts-ignore some problems with ref
-        ref={this.setRef}
-      />
-    );
-  }
-}
-
 const ReanimatedScreen = React.forwardRef<typeof AnimatedScreen, ScreenProps>(
   (props, ref) => {
-    const { children, ...rest } = props;
-
-    const progress = useSharedValue(0);
-    const closing = useSharedValue(0);
-    const goingForward = useSharedValue(0);
-
     return (
       <AnimatedScreen
         // @ts-ignore some problems with ref and onTransitionProgressReanimated being "fake" prop for parsing of `useEvent` return value
         ref={ref}
-        // ReanimatedScreen.tsx should only be used by Screens of native-stack, but it always better to check
-        onTransitionProgressReanimated={
-          !props.isNativeStack
-            ? undefined
-            : useEvent(
-                (event: TransitionProgressEventType) => {
-                  'worklet';
-                  progress.value = event.progress;
-                  closing.value = event.closing;
-                  goingForward.value = event.goingForward;
-                },
-                [
-                  // This should not be necessary, but is not properly managed by `react-native-reanimated`
-                  // @ts-ignore wrong type
-                  Platform.OS === 'android'
-                    ? 'onTransitionProgress'
-                    : 'topTransitionProgress',
-                ]
-              )
-        }
-        {...rest}>
-        {!props.isNativeStack ? ( // see comment of this prop in types.tsx for information why it is needed
-          children
-        ) : (
-          <ReanimatedTransitionProgressContext.Provider
-            value={{
-              progress: progress,
-              closing: closing,
-              goingForward: goingForward,
-            }}>
-            {children}
-          </ReanimatedTransitionProgressContext.Provider>
-        )}
-      </AnimatedScreen>
+        {...props}
+      />
     );
   }
 );
 
-// used to silence error "Component definition is missing display name"
 ReanimatedScreen.displayName = 'ReanimatedScreen';
 
-export default function ReanimatedScreenProvider(
-  props: PropsWithChildren<unknown>
-) {
-  return (
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    <ScreenContext.Provider value={ReanimatedScreenWrapper as any}>
-      {props.children}
-    </ScreenContext.Provider>
-  );
-}
+export default ReanimatedScreen;

package/src/reanimated/ReanimatedScreenProvider.tsx

@@ -0,0 +1,42 @@
+import React, { PropsWithChildren } from 'react';
+import { View } from 'react-native';
+import { ScreenProps, ScreenContext } from 'react-native-screens';
+import ReanimatedNativeStackScreen from './ReanimatedNativeStackScreen';
+import AnimatedScreen from './ReanimatedScreen';
+
+class ReanimatedScreenWrapper extends React.Component<ScreenProps> {
+  private ref: React.ElementRef<typeof View> | null = null;
+
+  setNativeProps(props: ScreenProps): void {
+    this.ref?.setNativeProps(props);
+  }
+
+  setRef = (ref: React.ElementRef<typeof View> | null): void => {
+    this.ref = ref;
+    this.props.onComponentRef?.(ref);
+  };
+
+  render() {
+    const ReanimatedScreen = this.props.isNativeStack
+      ? ReanimatedNativeStackScreen
+      : AnimatedScreen;
+    return (
+      <ReanimatedScreen
+        {...this.props}
+        // @ts-ignore some problems with ref
+        ref={this.setRef}
+      />
+    );
+  }
+}
+
+export default function ReanimatedScreenProvider(
+  props: PropsWithChildren<unknown>
+) {
+  return (
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    <ScreenContext.Provider value={ReanimatedScreenWrapper as any}>
+      {props.children}
+    </ScreenContext.Provider>
+  );
+}

package/src/reanimated/index.tsx

@@ -1,2 +1,2 @@
-export { default as ReanimatedScreenProvider } from './ReanimatedScreen';
+export { default as ReanimatedScreenProvider } from './ReanimatedScreenProvider';
 export { default as useReanimatedTransitionProgress } from './useReanimatedTransitionProgress';

package/src/types.tsx

@@ -331,6 +331,14 @@ export interface ScreenStackHeaderConfigProps extends ViewProps {
    * Boolean that allows for disabling drop shadow under navigation header when the edge of any scrollable content reaches the matching edge of the navigation bar.
    */
   largeTitleHideShadow?: boolean;
+  /**
+   * Callback which is executed when screen header is attached
+   */
+  onAttached?: () => void;
+  /**
+   * Callback which is executed when screen header is detached
+   */
+  onDetached?: () => void;
   /**
    * String that can be displayed in the header as a fallback for `headerTitle`.
    */
@@ -371,24 +379,47 @@ export interface SearchBarProps {
    * The auto-capitalization behavior
    */
   autoCapitalize?: 'none' | 'words' | 'sentences' | 'characters';
+  /**
+   * Automatically focuses search bar on mount
+   *
+   * @platform android
+   */
+  autoFocus?: boolean;
   /**
    * The search field background color
    */
   barTintColor?: string;
   /**
    * The text to be used instead of default `Cancel` button text
+   *
+   * @platform ios
    */
   cancelButtonText?: string;
-
+  /**
+   * Specifies whether the back button should close search bar's text input or not.
+   *
+   * @platform android
+   */
+  disableBackButtonOverride?: boolean;
   /**
    * Indicates whether to hide the navigation bar
+   *
+   * @platform ios
    */
   hideNavigationBar?: boolean;
   /**
    * Indicates whether to hide the search bar when scrolling
+   *
+   * @platform ios
    */
   hideWhenScrolling?: boolean;
 
+  /**
+   * Sets type of the input. Defaults to `text`.
+   *
+   * @platform android
+   */
+  inputType?: 'text' | 'phone' | 'number' | 'email';
   /**
    * Indicates whether to to obscure the underlying content
    */
@@ -399,6 +430,8 @@ export interface SearchBarProps {
   onBlur?: (e: NativeSyntheticEvent<TargetedEvent>) => void;
   /**
    * A callback that gets called when the cancel button is pressed
+   *
+   * @platform ios
    */
   onCancelButtonPress?: (e: NativeSyntheticEvent<TargetedEvent>) => void;
 
@@ -410,7 +443,19 @@ export interface SearchBarProps {
   /**
    * A callback that gets called when search bar has received focus
    */
+  onClose?: () => void;
+  /**
+   * A callback that gets called when search bar is opened
+   *
+   * @platform android
+   */
   onFocus?: (e: NativeSyntheticEvent<TargetedEvent>) => void;
+  /**
+   * A callback that gets called when search bar is closed
+   *
+   * @platform android
+   */
+  onOpen?: () => void;
   /**
    * A callback that gets called when the search button is pressed. It receives the current text value of the search bar.
    */

package/src/utils.ts

@@ -0,0 +1,12 @@
+import { BackHandler, Platform } from 'react-native';
+
+export const isSearchBarAvailableForCurrentPlatform = [
+  'ios',
+  'android',
+].includes(Platform.OS);
+
+export function executeNativeBackPress() {
+  // This function invokes the native back press event
+  BackHandler.exitApp();
+  return true;
+}