react-native-screens 4.0.0-beta.12 → 4.0.0-beta.14

package/src/native-stack/types.tsx

@@ -22,8 +22,11 @@ import {
   ScreenProps,
   ScreenStackHeaderConfigProps,
   SearchBarProps,
-} from 'react-native-screens';
+} from '../types';
 
+/**
+ * @deprecated NativeStack has been moved from react-native-screens/native-stack to @react-navigation/native since version v6. With react-native-screens v4 native stack v5 (react-native-screens/native-stack) is deprecated and marked for removal in the upcoming minor release, react-native-screens v4 will support only @react-navigation/native-stack v7.
+ */
 export type NativeStackNavigationEventMap = {
   /**
    * Event which fires when the screen appears.
@@ -62,6 +65,9 @@ export type NativeStackNavigationEventMap = {
   sheetDetentChange: { data: { index: number; isStable: boolean } };
 };
 
+/**
+ * @deprecated NativeStack has been moved from react-native-screens/native-stack to @react-navigation/native since version v6. With react-native-screens v4 native stack v5 (react-native-screens/native-stack) is deprecated and marked for removal in the upcoming minor release, react-native-screens v4 will support only @react-navigation/native-stack v7.
+ */
 export type NativeStackNavigationProp<
   ParamList extends ParamListBase,
   RouteName extends keyof ParamList = string,
@@ -74,6 +80,9 @@ export type NativeStackNavigationProp<
 > &
   StackActionHelpers<ParamList>;
 
+/**
+ * @deprecated NativeStack has been moved from react-native-screens/native-stack to @react-navigation/native since version v6. With react-native-screens v4 native stack v5 (react-native-screens/native-stack) is deprecated and marked for removal in the upcoming minor release, react-native-screens v4 will support only @react-navigation/native-stack v7.
+ */
 export type NativeStackScreenProps<
   ParamList extends ParamListBase,
   RouteName extends keyof ParamList = string,
@@ -82,15 +91,23 @@ export type NativeStackScreenProps<
   route: RouteProp<ParamList, RouteName>;
 };
 
+/**
+ * @deprecated NativeStack has been moved from react-native-screens/native-stack to @react-navigation/native since version v6. With react-native-screens v4 native stack v5 (react-native-screens/native-stack) is deprecated and marked for removal in the upcoming minor release, react-native-screens v4 will support only @react-navigation/native-stack v7.
+ */
 export type NativeStackNavigationHelpers = NavigationHelpers<
   ParamListBase,
   NativeStackNavigationEventMap
 >;
 
-// We want it to be an empty object beacuse navigator does not have any additional config
-// eslint-disable-next-line @typescript-eslint/ban-types
-export type NativeStackNavigationConfig = {};
+/**
+ * We want it to be an empty object beacuse navigator does not have any additional config
+ * @deprecated NativeStack has been moved from react-native-screens/native-stack to @react-navigation/native since version v6. With react-native-screens v4 native stack v5 (react-native-screens/native-stack) is deprecated and marked for removal in the upcoming minor release, react-native-screens v4 will support only @react-navigation/native-stack v7.
+ */
+export type NativeStackNavigationConfig = {}; // eslint-disable-line @typescript-eslint/ban-types
 
+/**
+ * @deprecated NativeStack has been moved from react-native-screens/native-stack to @react-navigation/native since version v6. With react-native-screens v4 native stack v5 (react-native-screens/native-stack) is deprecated and marked for removal in the upcoming minor release, react-native-screens v4 will support only @react-navigation/native-stack v7.
+ */
 export type NativeStackNavigationOptions = {
   /**
    * Image to display in the header as the back button.
@@ -527,11 +544,17 @@ export type NativeStackNavigationOptions = {
   unstable_sheetFooter?: () => React.ReactNode;
 };
 
+/**
+ * @deprecated NativeStack has been moved from react-native-screens/native-stack to @react-navigation/native since version v6. With react-native-screens v4 native stack v5 (react-native-screens/native-stack) is deprecated and marked for removal in the upcoming minor release, react-native-screens v4 will support only @react-navigation/native-stack v7.
+ */
 export type NativeStackNavigatorProps =
   DefaultNavigatorOptions<NativeStackNavigationOptions> &
     StackRouterOptions &
     NativeStackNavigationConfig;
 
+/**
+ * @deprecated NativeStack has been moved from react-native-screens/native-stack to @react-navigation/native since version v6. With react-native-screens v4 native stack v5 (react-native-screens/native-stack) is deprecated and marked for removal in the upcoming minor release, react-native-screens v4 will support only @react-navigation/native-stack v7.
+ */
 export type NativeStackDescriptor = Descriptor<
   ParamListBase,
   string,
@@ -539,11 +562,17 @@ export type NativeStackDescriptor = Descriptor<
   NativeStackNavigationOptions
 >;
 
+/**
+ * @deprecated NativeStack has been moved from react-native-screens/native-stack to @react-navigation/native since version v6. With react-native-screens v4 native stack v5 (react-native-screens/native-stack) is deprecated and marked for removal in the upcoming minor release, react-native-screens v4 will support only @react-navigation/native-stack v7.
+ */
 export type NativeStackDescriptorMap = {
   [key: string]: NativeStackDescriptor;
 };
 
-// copy from GestureHandler to avoid strong dependency
+/**
+ * copy from GestureHandler to avoid strong dependency
+ * @deprecated NativeStack has been moved from react-native-screens/native-stack to @react-navigation/native since version v6. With react-native-screens v4 native stack v5 (react-native-screens/native-stack) is deprecated and marked for removal in the upcoming minor release, react-native-screens v4 will support only @react-navigation/native-stack v7.
+ */
 export type PanGestureHandlerEventPayload = {
   x: number;
   y: number;
@@ -555,7 +584,10 @@ export type PanGestureHandlerEventPayload = {
   velocityY: number;
 };
 
-// copy from Reanimated to avoid strong dependency
+/**
+ * copy from Reanimated to avoid strong dependency
+ * @deprecated NativeStack has been moved from react-native-screens/native-stack to @react-navigation/native since version v6. With react-native-screens v4 native stack v5 (react-native-screens/native-stack) is deprecated and marked for removal in the upcoming minor release, react-native-screens v4 will support only @react-navigation/native-stack v7.
+ */
 export type GoBackGesture =
   | 'swipeRight'
   | 'swipeLeft'
@@ -565,6 +597,9 @@ export type GoBackGesture =
   | 'horizontalSwipe'
   | 'twoDimensionalSwipe';
 
+/**
+ * @deprecated NativeStack has been moved from react-native-screens/native-stack to @react-navigation/native since version v6. With react-native-screens v4 native stack v5 (react-native-screens/native-stack) is deprecated and marked for removal in the upcoming minor release, react-native-screens v4 will support only @react-navigation/native-stack v7.
+ */
 export interface MeasuredDimensions {
   x: number;
   y: number;
@@ -574,6 +609,9 @@ export interface MeasuredDimensions {
   pageY: number;
 }
 
+/**
+ * @deprecated NativeStack has been moved from react-native-screens/native-stack to @react-navigation/native since version v6. With react-native-screens v4 native stack v5 (react-native-screens/native-stack) is deprecated and marked for removal in the upcoming minor release, react-native-screens v4 will support only @react-navigation/native-stack v7.
+ */
 export type AnimatedScreenTransition = {
   topScreenStyle: (
     event: PanGestureHandlerEventPayload,
@@ -585,10 +623,16 @@ export type AnimatedScreenTransition = {
   ) => Record<string, unknown>;
 };
 
+/**
+ * @deprecated NativeStack has been moved from react-native-screens/native-stack to @react-navigation/native since version v6. With react-native-screens v4 native stack v5 (react-native-screens/native-stack) is deprecated and marked for removal in the upcoming minor release, react-native-screens v4 will support only @react-navigation/native-stack v7.
+ */
 export type ScreensRefsHolder = React.MutableRefObject<
   Record<string, React.MutableRefObject<React.Ref<NativeStackNavigatorProps>>>
 >;
 
+/**
+ * @deprecated NativeStack has been moved from react-native-screens/native-stack to @react-navigation/native since version v6. With react-native-screens v4 native stack v5 (react-native-screens/native-stack) is deprecated and marked for removal in the upcoming minor release, react-native-screens v4 will support only @react-navigation/native-stack v7.
+ */
 export type GestureProviderProps = PropsWithChildren<{
   gestureDetectorBridge: React.MutableRefObject<GestureDetectorBridge>;
   screensRefs: ScreensRefsHolder;

package/src/native-stack/utils/getDefaultHeaderHeight.tsx

@@ -1,5 +1,5 @@
 import { Platform } from 'react-native';
-import { StackPresentationTypes } from 'react-native-screens';
+import { StackPresentationTypes } from '../../types';
 type Layout = { width: number; height: number };
 
 const formSheetModalHeight = 56;

package/src/native-stack/views/FooterComponent.tsx

@@ -1,5 +1,5 @@
 import React from 'react';
-import { ScreenFooter } from 'react-native-screens';
+import ScreenFooter from '../../components/ScreenFooter';
 
 type FooterProps = {
   children?: React.ReactNode;

package/src/native-stack/views/HeaderConfig.tsx

@@ -1,6 +1,11 @@
 import { Route, useTheme } from '@react-navigation/native';
 import * as React from 'react';
 import { Platform } from 'react-native';
+import { SearchBarProps } from '../../types';
+import {
+  isSearchBarAvailableForCurrentPlatform,
+  executeNativeBackPress,
+} from '../../utils';
 import {
   ScreenStackHeaderBackButtonImage,
   ScreenStackHeaderCenterView,
@@ -8,11 +13,8 @@ import {
   ScreenStackHeaderLeftView,
   ScreenStackHeaderRightView,
   ScreenStackHeaderSearchBarView,
-  SearchBar,
-  SearchBarProps,
-  isSearchBarAvailableForCurrentPlatform,
-  executeNativeBackPress,
-} from 'react-native-screens';
+} from '../../components/ScreenStackHeaderConfig';
+import SearchBar from '../../components/SearchBar';
 import { NativeStackNavigationOptions } from '../types';
 import { useBackPressSubscription } from '../utils/useBackPressSubscription';
 import { processFonts } from './FontProcessor';

package/src/native-stack/views/NativeStackView.tsx

@@ -5,14 +5,11 @@ import { Animated, Platform, StyleSheet, ViewProps } from 'react-native';
 // eslint-disable-next-line import/no-named-as-default, import/default, import/no-named-as-default-member, import/namespace
 import AppContainer from 'react-native/Libraries/ReactNative/AppContainer';
 import warnOnce from 'warn-once';
-import {
-  ScreenStack,
-  StackPresentationTypes,
-  ScreenContext,
-  GHContext,
-  GestureDetectorBridge,
-  ScreenContentWrapper,
-} from 'react-native-screens';
+import { StackPresentationTypes, GestureDetectorBridge } from '../../types';
+import ScreenStack from '../../components/ScreenStack';
+import ScreenContentWrapper from '../../components/ScreenContentWrapper';
+import { GHContext } from '../contexts/GHContext';
+import { ScreenContext } from '../../components/Screen';
 import {
   ParamListBase,
   StackActions,

package/src/reanimated/ReanimatedNativeStackScreen.tsx

@@ -1,11 +1,11 @@
 import React from 'react';
 import { Platform } from 'react-native';
+import { InnerScreen } from '../components/Screen';
 import {
   HeaderHeightChangeEventType,
-  InnerScreen,
   ScreenProps,
   TransitionProgressEventType,
-} from 'react-native-screens';
+} from '../types';
 
 // @ts-ignore file to be used only if `react-native-reanimated` available in the project
 import Animated, { useEvent, useSharedValue } from 'react-native-reanimated';

package/src/reanimated/ReanimatedScreen.tsx

@@ -1,5 +1,6 @@
 import React from 'react';
-import { InnerScreen, ScreenProps } from 'react-native-screens';
+import { InnerScreen } from '../components/Screen';
+import { ScreenProps } from '../types';
 
 // @ts-ignore file to be used only if `react-native-reanimated` available in the project
 import Animated from 'react-native-reanimated';

package/src/reanimated/ReanimatedScreenProvider.tsx

@@ -1,6 +1,7 @@
 import React, { PropsWithChildren } from 'react';
 import { View } from 'react-native';
-import { ScreenProps, ScreenContext } from 'react-native-screens';
+import { ScreenContext } from '../components/Screen';
+import { ScreenProps } from '../types';
 import ReanimatedNativeStackScreen from './ReanimatedNativeStackScreen';
 import AnimatedScreen from './ReanimatedScreen';
 

package/src/types.tsx

@@ -42,6 +42,7 @@ export type StackAnimationTypes =
   | 'ios_from_right'
   | 'ios_from_left';
 export type BlurEffectTypes =
+  | 'none'
   | 'extraLight'
   | 'light'
   | 'dark'

package/src/utils.ts

@@ -11,8 +11,30 @@ export function executeNativeBackPress() {
   return true;
 }
 
-// Because of a bug introduced in https://github.com/software-mansion/react-native-screens/pull/1646
-// react-native-screens v3.21 changed how header's backTitle handles whitespace strings in https://github.com/software-mansion/react-native-screens/pull/1726
-// To allow for backwards compatibility in @react-navigation/native-stack we need a way to check if this version or newer is used.
-// See https://github.com/react-navigation/react-navigation/pull/11423 for more context.
-export const isNewBackTitleImplementation = true;
+/**
+ * Exposes information useful for downstream navigation library implementers,
+ * so they can keep reasonable backward compatibility, if desired.
+ *
+ * We don't mean for this object to only grow in number of fields, however at the same time
+ * we won't be very hasty to reduce it. Expect gradual changes.
+ */
+export const compatibilityFlags = {
+  /**
+   * Because of a bug introduced in https://github.com/software-mansion/react-native-screens/pull/1646
+   * react-native-screens v3.21 changed how header's backTitle handles whitespace strings in https://github.com/software-mansion/react-native-screens/pull/1726
+   * To allow for backwards compatibility in @react-navigation/native-stack we need a way to check if this version or newer is used.
+   * See https://github.com/react-navigation/react-navigation/pull/11423 for more context.
+   */
+  isNewBackTitleImplementation: true,
+
+  /**
+   * With version 4.0.0 the header implementation has been changed. To allow for backward compat
+   * with native-stack@v6 we want to expose a way to check whether the new implementation
+   * is in use or not.
+   *
+   * See:
+   * * https://github.com/software-mansion/react-native-screens/pull/2325
+   * * https://github.com/react-navigation/react-navigation/pull/12125
+   */
+  usesHeaderFlexboxImplementation: true,
+};