react-native-screens 4.24.0 → 4.25.0-beta.1

package/src/components/tabs/TabsScreen.types.ts

@@ -1,630 +0,0 @@
-import type {
-  ColorValue,
-  NativeSyntheticEvent,
-  StyleProp,
-  TextStyle,
-  ViewProps,
-  ViewStyle,
-} from 'react-native';
-import type {
-  PlatformIcon,
-  PlatformIconIOS,
-  UserInterfaceStyle,
-  ScrollEdgeEffect,
-} from '../../types';
-
-export type EmptyObject = Record<string, never>;
-
-export type TabsScreenEventHandler<T> = (
-  event: NativeSyntheticEvent<T>,
-) => void;
-
-export type LifecycleStateChangeEvent = Readonly<{
-  previousState: number;
-  newState: number;
-}>;
-
-// iOS-specific
-export type TabsScreenBlurEffect =
-  | 'none'
-  | 'systemDefault'
-  | 'extraLight'
-  | 'light'
-  | 'dark'
-  | 'regular'
-  | 'prominent'
-  | 'systemUltraThinMaterial'
-  | 'systemThinMaterial'
-  | 'systemMaterial'
-  | 'systemThickMaterial'
-  | 'systemChromeMaterial'
-  | 'systemUltraThinMaterialLight'
-  | 'systemThinMaterialLight'
-  | 'systemMaterialLight'
-  | 'systemThickMaterialLight'
-  | 'systemChromeMaterialLight'
-  | 'systemUltraThinMaterialDark'
-  | 'systemThinMaterialDark'
-  | 'systemMaterialDark'
-  | 'systemThickMaterialDark'
-  | 'systemChromeMaterialDark';
-
-export type TabsSystemItem =
-  | 'bookmarks'
-  | 'contacts'
-  | 'downloads'
-  | 'favorites'
-  | 'featured'
-  | 'history'
-  | 'more'
-  | 'mostRecent'
-  | 'mostViewed'
-  | 'recents'
-  | 'search'
-  | 'topRated';
-
-// Currently iOS-only
-export type TabsScreenOrientation =
-  | 'inherit'
-  | 'all'
-  | 'allButUpsideDown'
-  | 'portrait'
-  | 'portraitUp'
-  | 'portraitDown'
-  | 'landscape'
-  | 'landscapeLeft'
-  | 'landscapeRight';
-
-// iOS-specific
-export interface TabsScreenAppearance {
-  /**
-   * @summary Specifies the appearance of tab bar items when they are in stacked layout.
-   *
-   * Tab bar items in stacked layout have the icon above the title.
-   * Stacked layout is used e.g. on the iPhone in portrait orientation.
-   *
-   * @platform ios
-   */
-  stacked?: TabsScreenItemAppearance;
-  /**
-   * @summary Specifies the appearance of tab bar items when they are in inline layout.
-   *
-   * Tab bar items in inline layout have the icon next to the title.
-   * Inline layout is used in regular-width environments, e.g. in landscape orientation on the iPhone 16 Pro Max.
-   *
-   * Complete list of size classes for iOS and iPadOS devices is available in Apple's Human Interface Guidelines:
-   * @see {@link https://developer.apple.com/design/human-interface-guidelines/layout#iOS-iPadOS-device-size-classes|HIG: Device size classes}
-   *
-   * @platform ios
-   */
-  inline?: TabsScreenItemAppearance;
-  /**
-   * @summary Specifies the appearance of tab bar items when they are in compact inline layout.
-   *
-   * Tab bar items in compact inline layout have the icon next to the title.
-   * Compact inline layout is used in compact-width environments, e.g. in landscape orientation on the iPhone 16 Pro.
-   *
-   * Complete list of size classes for iOS and iPadOS devices is available in Apple's Human Interface Guidelines:
-   * @see {@link https://developer.apple.com/design/human-interface-guidelines/layout#iOS-iPadOS-device-size-classes|HIG: Device size classes}
-   *
-   * @platform ios
-   */
-  compactInline?: TabsScreenItemAppearance;
-
-  /**
-   * @summary Specifies the background color for the entire tab bar when tab screen is selected.
-   *
-   * This property does not affect the tab bar starting from iOS 26.
-   *
-   * @platform ios
-   * @supported iOS 18 or lower
-   */
-  tabBarBackgroundColor?: ColorValue;
-  /**
-   * @summary Specifies the blur effect applied to the tab bar when tab screen is selected.
-   *
-   * Works with backgroundColor's alpha < 1.
-   *
-   * This property does not affect the tab bar starting from iOS 26.
-   *
-   * The following values are currently supported:
-   *
-   * - `none` - disables blur effect
-   * - `systemDefault` - uses UIKit's default tab bar blur effect
-   * - one of styles mapped from UIKit's UIBlurEffectStyle, e.g. `systemUltraThinMaterial`
-   *
-   * Complete list of possible blur effect styles is available in the official UIKit documentation:
-   * @see {@link https://developer.apple.com/documentation/uikit/uiblureffect/style|UIBlurEffect.Style}
-   *
-   * @default systemDefault
-   *
-   * @platform ios
-   * @supported iOS 18 or lower
-   */
-  tabBarBlurEffect?: TabsScreenBlurEffect;
-  /**
-   * @summary Specifies the shadow color for the tab bar when tab screen is selected.
-   *
-   * This property does not affect the tab bar starting from iOS 26.
-   *
-   * @platform ios
-   * @supported iOS 18 or lower
-   */
-  tabBarShadowColor?: ColorValue;
-}
-
-// iOS-specific
-export interface TabsScreenItemAppearance {
-  /**
-   * Specifies the tab bar item appearance when it's enabled, unselected, and not the focused item.
-   *
-   * @platform ios
-   */
-  normal?: TabsScreenItemStateAppearance;
-  /**
-   * Specifies the tab bar item appearance when it's selected.
-   *
-   * @platform ios
-   */
-  selected?: TabsScreenItemStateAppearance;
-  /**
-   * Specifies the tab bar item appearance when it's focused.
-   *
-   * @platform ios
-   */
-  focused?: TabsScreenItemStateAppearance;
-  /**
-   * Specifies the tab bar item appearance when it's disabled.
-   *
-   * @platform ios
-   */
-  disabled?: TabsScreenItemStateAppearance;
-}
-
-// iOS-specific
-export interface TabsScreenItemStateAppearance {
-  /**
-   * @summary Specifies the font family used for the title of each tab bar item
-   * when tab screen is selected.
-   *
-   * @platform ios
-   */
-  tabBarItemTitleFontFamily?: TextStyle['fontFamily'];
-  /**
-   * @summary Specifies the font size used for the title of each tab bar item
-   * when tab screen is selected.
-   *
-   * @platform ios
-   */
-  tabBarItemTitleFontSize?: TextStyle['fontSize'];
-  /**
-   * @summary Specifies the font weight used for the title of each tab bar item
-   * when tab screen is selected.
-   *
-   * @platform ios
-   */
-  tabBarItemTitleFontWeight?: TextStyle['fontWeight'];
-  /**
-   * @summary Specifies the font style used for the title of each tab bar item
-   * when tab screen is selected.
-   *
-   * @platform ios
-   */
-  tabBarItemTitleFontStyle?: TextStyle['fontStyle'];
-  /**
-   * @summary Specifies the font color used for the title of each tab bar item
-   * when tab screen is selected.
-   *
-   * Overrides the color defined in `tabBarTintColor` and `tabBarItemIconColor`.
-   *
-   * @platform ios
-   */
-  tabBarItemTitleFontColor?: TextStyle['color'];
-  /**
-   * @summary Specifies the title offset for each tab bar item when tab screen
-   * is selected.
-   *
-   * Depending on the iOS version and the device's interface orientation,
-   * this setting may affect the alignment of the text, badge and icon.
-   *
-   * @platform ios
-   */
-  tabBarItemTitlePositionAdjustment?: {
-    horizontal?: number;
-    vertical?: number;
-  };
-  /**
-   * @summary Specifies the icon color for each tab bar item when tab screen
-   * is selected.
-   *
-   * This also impacts the title text color.
-   *
-   * Starting from iOS 26, it only applies to selected tab bar item. Other items
-   * adopt a dark or light appearance depending on the theme of the tab bar.
-   *
-   * Is overridden by `tabBarItemTitleFontColor` (for title text color).
-   * Overrides `tabBarTintColor`.
-   *
-   * @platform ios
-   */
-  tabBarItemIconColor?: ColorValue;
-  /**
-   * @summary Specifies the background color of badges for each tab bar item
-   * when tab screen is selected.
-   *
-   * @platform ios
-   */
-  tabBarItemBadgeBackgroundColor?: ColorValue;
-}
-
-export interface TabsScreenProps {
-  // #region Control
-  /**
-   * @summary Determines selected tab.
-   *
-   * In controlled container mode, determines if tab screen is currently
-   * focused.
-   *
-   * In managed container mode, it only indicates initially selected tab.
-   *
-   * There should be exactly one focused screen at any given time.
-   *
-   * @platform android, ios
-   */
-  isFocused?: boolean;
-  /**
-   * @summary Identifies screen, e.g. when receiving onNativeFocusChange event.
-   *
-   * @platform android, ios
-   */
-  tabKey: string;
-  // #endregion
-
-  // #region General
-  children?: ViewProps['children'];
-  style?: StyleProp<Pick<ViewStyle, 'backgroundColor'>>;
-  /**
-   * @summary Defines what should be rendered when tab screen is frozen.
-   *
-   * @see {@link https://github.com/software-mansion/react-freeze|`react-freeze`'s GitHub repository} for more information about `react-freeze`.
-   *
-   * @platform android, ios
-   */
-  placeholder?: React.ReactNode | undefined;
-  /**
-   * @summary Title of the tab screen, displayed in the tab bar item.
-   *
-   * @platform android, ios
-   */
-  title?: string;
-  /**
-   * @summary Specifies content of tab bar item badge.
-   *
-   * On iOS, badge is displayed as regular string.
-   *
-   * On Android, the value is interpreted in the following order:
-   * - if the string can be parsed to integer, displays the value as a number;
-   * - otherwise if the string is empty, displays "small dot" badge;
-   * - otherwise, displays the value as a text.
-   *
-   * @platform android, ios
-   */
-  badgeValue?: string;
-  /**
-   * @summary Specifies the icon for the tab bar item.
-   *
-   * You can define an icon separately for each platform (in `ios` and `android`)
-   * or define a default icon in `shared`. The shared icon will be used on both
-   * platforms unless it is overridden by a platform-specific definition
-   * in `ios` or `android`.
-   *
-   * Supported values:
-   *
-   * Shared (both iOS and Android):
-   * - `{ type: 'imageSource', imageSource }`
-   *   Uses an image from the provided resource.
-   *
-   *   Remarks: `imageSource` type doesn't support SVGs on Android.
-   *   For loading SVGs use `drawableResource` type.
-   *
-   * iOS-only:
-   * - `{ type: 'sfSymbol', name }`
-   *   Uses an SF Symbol with the specified name.
-   * - `{ type: 'xcasset', name }`
-   *   Uses asset from Xcassets.
-   * - `{ type: 'templateSource', templateSource }`
-   *   Uses the provided image as a template image.
-   *   The icon color will depend on the current state
-   *   of the tab bar item and icon color-related props.
-   *
-   * Android-only:
-   * - `{ type: 'drawableResource', name }`
-   *   Uses a drawable resource with the given name.
-   *
-   *   Remarks: Requires passing a drawable to resources via Android Studio.
-   *
-   * On iOS, if no `selectedIcon` is provided, this icon will also
-   * be used as the selected state icon.
-   *
-   * @platform android, ios
-   */
-  icon?: PlatformIcon;
-  /**
-   * @summary Specifies which special effects (also known as microinteractions)
-   * are enabled for the tab screen.
-   *
-   * For repeated tab selection (selecting already focused tab bar item),
-   * there are 2 supported special effects:
-   * - `popToRoot` - when Stack is nested inside tab screen and repeated
-   *   selection is detected, the Stack will pop to root screen,
-   * - `scrollToTop` - when there is a ScrollView in first descendant
-   *   chain from tab screen and repeated selection is detected, ScrollView
-   *   will be scrolled to top.
-   *
-   * `popToRoot` has priority over `scrollToTop`.
-   *
-   * @default All special effects are enabled by default.
-   *
-   * @platform android, ios
-   */
-  specialEffects?: {
-    repeatedTabSelection?: {
-      /**
-       * @default true
-       */
-      popToRoot?: boolean;
-      /**
-       * @default true
-       */
-      scrollToTop?: boolean;
-    };
-  };
-  /**
-   * @summary Allows to control whether contents of a tab screen should be frozen or not. This overrides any default behavior.
-   *
-   * @default undefined
-   *
-   * @platform android, ios
-   */
-  freezeContents?: boolean;
-  // #endregion General
-
-  // #region Accessibility
-
-  /**
-   * @summary testID for the TabsScreen
-   */
-  testID?: string;
-
-  /**
-   * @summary accessibilityLabel for the TabsScreen
-   */
-  accessibilityLabel?: string;
-
-  /**
-   * @summary testID for the TabBarItem
-   */
-  tabBarItemTestID?: string;
-
-  /**
-   * @summary accessibilityLabel for the TabBarItem
-   *
-   * @supported iOS, Android API level >=26
-   */
-  tabBarItemAccessibilityLabel?: string;
-
-  // #endregion Accessibility
-
-  // #region Android-only
-  /**
-   * @summary Specifies the color of the text in the badge.
-   *
-   * @platform android
-   */
-  tabBarItemBadgeTextColor?: ColorValue;
-  /**
-   * @summary Specifies the background color of the badge.
-   *
-   * @platform android
-   */
-  tabBarItemBadgeBackgroundColor?: ColorValue;
-  // #endregion Android-only
-
-  // #region iOS-only
-  /**
-   * @summary Specifies supported orientations for the tab screen.
-   *
-   * Procedure for determining supported orientations:
-   * 1. Traversal initiates from the root component and moves to the
-   *    deepest child possible.
-   * 2. Components are queried for their supported orientations:
-   *    - if `orientation` is explicitly set (e.g., `portrait`,
-   *      `landscape`), it is immediately used,
-   *    - if `orientation` is set to `inherit`, the parent component
-   *      is queried.
-   *
-   * Note that:
-   * - some components (like `SplitHost`) may choose not to query
-   *   its child components,
-   * - Stack v4 implementation **ALWAYS** returns some supported
-   *   orientations (`allButUpsideDown` by default), overriding
-   *   orientation from tab screen.
-   *
-   * The following values are currently supported:
-   *
-   * - `inherit` - tab screen supports the same orientations as parent
-   *   component,
-   * - `all` - tab screen supports all orientations,
-   * - `allButUpsideDown` - tab screen supports all but the upside-down
-   *   portrait interface orientation,
-   * - `portrait` - tab screen supports both portrait-up and portrait-down
-   *   interface orientations,
-   * - 'portraitUp' - tab screen supports a portrait-up interface
-   *   orientation,
-   * - `portraitDown` - tab screen supports a portrait-down interface
-   *   orientation,
-   * - `landscape` - tab screen supports both landscape-left and
-   *   landscape-right interface orientations,
-   * - `landscapeLeft` - tab screen supports landscape-left interface
-   *   orientaion,
-   * - `landscapeRight` - tab screen supports landscape-right interface
-   *   orientaion.
-   *
-   * The supported values (apart from `inherit`, `portrait`, `portraitUp`,
-   * `portraitDown`) correspond to the official UIKit documentation:
-   *
-   * @see {@link https://developer.apple.com/documentation/uikit/uiinterfaceorientationmask|UIInterfaceOrientationMask}
-   *
-   * @default inherit
-   *
-   * @platform ios
-   */
-  orientation?: TabsScreenOrientation;
-  /**
-   * @summary Specifies the standard tab bar appearance.
-   *
-   * Allows to customize the appearance depending on the tab bar item layout (stacked,
-   * inline, compact inline) and state (normal, selected, focused, disabled).
-   *
-   * @platform ios
-   */
-  standardAppearance?: TabsScreenAppearance;
-  /**
-   * @summary Specifies the tab bar appearace when edge of scrollable content aligns
-   * with the edge of the tab bar.
-   *
-   * Allows to customize the appearance depending on the tab bar item layout (stacked,
-   * inline, compact inline) and state (normal, selected, focused, disabled).
-   *
-   * If this property is `undefined`, UIKit uses `standardAppearance`, modified to
-   * have a transparent background.
-   *
-   * @platform ios
-   */
-  scrollEdgeAppearance?: TabsScreenAppearance;
-  /**
-   * @summary Specifies the icon for tab bar item when it is selected.
-   *
-   * Supports the same values as `icon` property for iOS.
-   *
-   * To use `selectedIcon`, `icon` must also be provided.
-   *
-   * @platform ios
-   */
-  selectedIcon?: PlatformIconIOS;
-  /**
-   * @summary System-provided tab bar item with predefined icon and title
-   *
-   * Uses Apple's built-in tab bar items (e.g., bookmarks, contacts, downloads) with
-   * standard iOS styling and localized titles. Custom `icon` or `selectedIcon`
-   * properties will override the system icon, but the system-defined title cannot
-   * be customized.
-   *
-   * @see {@link https://developer.apple.com/documentation/uikit/uitabbaritem/systemitem|UITabBarItem.SystemItem}
-   *
-   * @platform ios
-   */
-  systemItem?: TabsSystemItem;
-  /**
-   * @summary Specifies if `contentInsetAdjustmentBehavior` of first ScrollView
-   * in first descendant chain from tab screen should be overridden back from `never`
-   * to `automatic`.
-   *
-   * By default, `react-native`'s ScrollView has `contentInsetAdjustmentBehavior`
-   * set to `never` instead of UIKit-default (which is `automatic`). This
-   * prevents ScrollViews from respecting navigation bar insets.
-   * When this prop is set to `true`, `automatic` behavior is reverted.
-   *
-   * Supported only on Fabric.
-   *
-   * @default true
-   *
-   * @platform ios
-   */
-  overrideScrollViewContentInsetAdjustmentBehavior?: boolean;
-  /**
-   * Configures the scroll edge effect for the _content ScrollView_ (the ScrollView that is present in first descendants chain of the Screen).
-   * Depending on values set, it will blur the scrolling content below certain UI elements (header items, search bar)
-   * for the specified edge of the ScrollView.
-   *
-   * When set in nested containers, i.e. ScreenStack inside BottomTabs, or the other way around,
-   * the ScrollView will use only the innermost one's config.
-   *
-   * Edge effects can be configured for each edge separately. The following values are currently supported:
-   *
-   * - `automatic` - the automatic scroll edge effect style,
-   * - `hard` - a scroll edge effect with a hard cutoff and dividing line,
-   * - `soft` - a soft-edged scroll edge effect,
-   * - `hidden` - no scroll edge effect.
-   *
-   * The supported values correspond to the `UIScrollEdgeEffect`'s `style` and `isHidden` props
-   * in the official UIKit documentation:
-   *
-   * @see {@link https://developer.apple.com/documentation/uikit/uiscrolledgeeffect|UIScrollEdgeEffect}
-   *
-   * @default `automatic` for each edge
-   *
-   * @platform ios
-   *
-   * @supported iOS 26 or higher
-   */
-  scrollEdgeEffects?: {
-    bottom?: ScrollEdgeEffect;
-    left?: ScrollEdgeEffect;
-    right?: ScrollEdgeEffect;
-    top?: ScrollEdgeEffect;
-  };
-  /**
-   * @summary Allows to override system appearance for the tab bar.
-   *
-   * Does not support dynamic changes to the prop value for the currently visible screen.
-   *
-   * Please note that this prop is marked as **experimental** and might be subject to breaking changes or even removal.
-   *
-   * The following values are currently supported:
-   * - `unspecified` - an unspecified interface style,
-   * - `light` - the light interface style,
-   * - `dark` - the dark interface style.
-   *
-   * The supported values correspond to the official UIKit documentation:
-   *
-   * @see {@link https://developer.apple.com/documentation/uikit/uiuserinterfacestyle|UIUserInterfaceStyle}
-   *
-   * @default unspecified
-   *
-   * @platform ios
-   */
-  experimental_userInterfaceStyle?: UserInterfaceStyle;
-  // #endregion iOS-only
-
-  // #region Events
-  /**
-   * @summary A callback that gets invoked when the tab screen will appear.
-   * This is called as soon as the transition begins.
-   *
-   * @platform android, ios
-   */
-  onWillAppear?: TabsScreenEventHandler<EmptyObject>;
-  /**
-   * @summary A callback that gets invoked when the tab screen did appear.
-   * This is called as soon as the transition ends.
-   *
-   * @platform android, ios
-   */
-  onDidAppear?: TabsScreenEventHandler<EmptyObject>;
-  /**
-   * @summary A callback that gets invoked when the tab screen will disappear.
-   * This is called as soon as the transition begins.
-   *
-   * @platform android, ios
-   */
-  onWillDisappear?: TabsScreenEventHandler<EmptyObject>;
-  /**
-   * @summary A callback that gets invoked when the tab screen did disappear.
-   * This is called as soon as the transition ends.
-   *
-   * @platform android, ios
-   */
-  onDidDisappear?: TabsScreenEventHandler<EmptyObject>;
-  // #endregion Events
-}

package/src/experimental/types.ts

@@ -1,10 +0,0 @@
-/**
- * ALL SYMBOLS EXPOSED FROM THIS MODULE ARE EXPERIMENTAL AND MIGHT
- * BE SUBJECT TO BREAKING CHANGES WITHOUT NOTICE OR LIBRARY MAJOR VERSION CHANGE.
- */
-
-export * from '../components/gamma/stack/StackHost.types';
-export * from '../components/gamma/split/SplitHost.types';
-export * from '../components/gamma/split/SplitScreen.types';
-export * from '../components/gamma/stack/StackScreen.types';
-export * from '../components/safe-area/SafeAreaView.types';

package/src/fabric/gamma/SplitViewScreenNativeComponent.ts

@@ -1,24 +0,0 @@
-'use client';
-
-import type { CodegenTypes as CT, ViewProps } from 'react-native';
-import { codegenNativeComponent } from 'react-native';
-
-// eslint-disable-next-line @typescript-eslint/ban-types
-type GenericEmptyEvent = Readonly<{}>;
-
-type SplitViewScreenColumnType = 'column' | 'inspector';
-
-interface NativeProps extends ViewProps {
-  // Config
-  columnType?: CT.WithDefault<SplitViewScreenColumnType, 'column'>;
-
-  // Events
-  onWillAppear?: CT.DirectEventHandler<GenericEmptyEvent>;
-  onDidAppear?: CT.DirectEventHandler<GenericEmptyEvent>;
-  onWillDisappear?: CT.DirectEventHandler<GenericEmptyEvent>;
-  onDidDisappear?: CT.DirectEventHandler<GenericEmptyEvent>;
-}
-
-export default codegenNativeComponent<NativeProps>('RNSSplitViewScreen', {
-  interfaceOnly: true,
-});