react-native-screens 4.12.0 → 4.13.0

package/src/fabric/gamma/SplitViewHostNativeComponent.ts

@@ -0,0 +1,39 @@
+'use client';
+
+import type { ViewProps } from 'react-native';
+import codegenNativeComponent from 'react-native/Libraries/Utilities/codegenNativeComponent';
+import type { WithDefault } from 'react-native/Libraries/Types/CodegenTypes';
+
+export type SplitViewSplitBehavior =
+  | 'automatic'
+  | 'displace'
+  | 'overlay'
+  | 'tile';
+
+export type SplitViewPrimaryEdge = 'leading' | 'trailing';
+
+export type SplitViewDisplayMode =
+  | 'automatic'
+  | 'secondaryOnly'
+  | 'oneBesideSecondary'
+  | 'oneOverSecondary'
+  | 'twoBesideSecondary'
+  | 'twoOverSecondary'
+  | 'twoDisplaceSecondary';
+
+export interface NativeProps extends ViewProps {
+  // Appearance
+
+  displayMode?: WithDefault<SplitViewDisplayMode, 'automatic'>;
+  splitBehavior?: WithDefault<SplitViewSplitBehavior, 'automatic'>;
+  primaryEdge?: WithDefault<SplitViewPrimaryEdge, 'leading'>;
+
+  // NOTE: this setter cannot change the value dynamically, even in pure native app
+  showSecondaryToggleButton?: WithDefault<boolean, false>;
+
+  // Interactions
+
+  presentsWithGesture?: WithDefault<boolean, true>;
+}
+
+export default codegenNativeComponent<NativeProps>('RNSSplitViewHost', {});

package/src/fabric/gamma/SplitViewScreenNativeComponent.ts

@@ -0,0 +1,10 @@
+'use client';
+
+import type { ViewProps } from 'react-native';
+import codegenNativeComponent from 'react-native/Libraries/Utilities/codegenNativeComponent';
+
+export interface NativeProps extends ViewProps {}
+
+export default codegenNativeComponent<NativeProps>('RNSSplitViewScreen', {
+  interfaceOnly: true,
+});

package/src/fabric/gamma/StackScreenNativeComponent.ts

@@ -0,0 +1,25 @@
+'use client';
+
+import type { ViewProps } from 'react-native';
+import {
+  DirectEventHandler,
+  Int32,
+} from 'react-native/Libraries/Types/CodegenTypes';
+import codegenNativeComponent from 'react-native/Libraries/Utilities/codegenNativeComponent';
+
+// eslint-disable-next-line @typescript-eslint/ban-types
+export type GenericEmptyEvent = Readonly<{}>;
+
+export interface NativeProps extends ViewProps {
+  // Control
+  maxLifecycleState: Int32;
+  screenKey: string;
+
+  // Events
+  onWillAppear?: DirectEventHandler<GenericEmptyEvent>;
+  onDidAppear?: DirectEventHandler<GenericEmptyEvent>;
+  onWillDisappear?: DirectEventHandler<GenericEmptyEvent>;
+  onDidDisappear?: DirectEventHandler<GenericEmptyEvent>;
+}
+
+export default codegenNativeComponent<NativeProps>('RNSStackScreen', {});

package/src/flags.ts

@@ -0,0 +1,72 @@
+const RNS_CONTROLLED_BOTTOM_TABS_DEFAULT = true;
+
+// TODO: Migrate freeze here
+
+/**
+ * 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,
+} as const;
+
+const _featureFlags = {
+  experiment: {
+    controlledBottomTabs: RNS_CONTROLLED_BOTTOM_TABS_DEFAULT,
+  },
+  stable: {},
+};
+
+/**
+ * Exposes configurable global behaviour of the library.
+ *
+ * Most of these can be overridden on particular component level, these are global switches.
+ */
+export const featureFlags = {
+  /**
+   *  Flags to enable experimental features. These might be removed w/o notice or moved to stable.
+   */
+  experiment: {
+    get controlledBottomTabs() {
+      return _featureFlags.experiment.controlledBottomTabs;
+    },
+    set controlledBottomTabs(value: boolean) {
+      if (
+        value !== _featureFlags.experiment.controlledBottomTabs &&
+        _featureFlags.experiment.controlledBottomTabs !==
+          RNS_CONTROLLED_BOTTOM_TABS_DEFAULT
+      ) {
+        console.error(
+          `[RNScreens] controlledBottomTabs feature flag modified for a second time; this might lead to unexpected effects`,
+        );
+      }
+      _featureFlags.experiment.controlledBottomTabs = value;
+    },
+  },
+  /**
+   * Section for stable flags, which can be used to configure library behaviour.
+   */
+  stable: {},
+};
+
+export default featureFlags;

package/src/index.tsx

@@ -46,11 +46,28 @@ export { default as ScreenContentWrapper } from './components/ScreenContentWrapp
  */
 export {
   isSearchBarAvailableForCurrentPlatform,
-  compatibilityFlags,
   executeNativeBackPress,
 } from './utils';
 
+/**
+ * Flags
+ */
+export { compatibilityFlags, featureFlags } from './flags';
+
 /**
  * Hooks
  */
 export { default as useTransitionProgress } from './useTransitionProgress';
+
+/**
+ * EXPERIMENTAL API BELOW. MIGHT CHANGE W/O ANY NOTICE
+ */
+export { default as BottomTabs } from './components/BottomTabs';
+export { default as BottomTabsScreen } from './components/BottomTabsScreen';
+export { default as ScreenStackHost } from './components/gamma/ScreenStackHost';
+export {
+  default as StackScreen,
+  StackScreenLifecycleState,
+} from './components/gamma/StackScreen';
+export { default as SplitViewHost } from './components/gamma/SplitViewHost';
+export { default as SplitViewScreen } from './components/gamma/SplitViewScreen';

package/src/utils.ts

@@ -10,31 +10,3 @@ export function executeNativeBackPress() {
   BackHandler.exitApp();
   return 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,
-};