diff --git a/packages/bottom-tabs/src/types.tsx b/packages/bottom-tabs/src/types.tsx index 8985eefe..0b215f80 100644 --- a/packages/bottom-tabs/src/types.tsx +++ b/packages/bottom-tabs/src/types.tsx @@ -83,6 +83,7 @@ export type TabBarVisibilityAnimationConfig = export type NativeScreenTraitsProps = { /** * In which orientation should the screen appear. It requires having `react-native-screens` enabled. + * On Android, requires `react-native-screens` version >=3.3.0. * The following values are currently supported: * - "default" - resolves to "all" without "portrait_down" on iOS. On Android, this lets the system decide the best orientation. * - "all" – all orientations are permitted @@ -103,21 +104,28 @@ export type NativeScreenTraitsProps = { | 'landscape_left' | 'landscape_right'; /** - * Sets the status bar animation (similar to the `StatusBar` component). Requires enabling (or deleting) `View controller-based status bar appearance` in your Info.plist file and having `react-native-screens` enabled. On Android, requires `react-native-screens` version >=3.3.0. + * Sets the status bar animation (similar to the `StatusBar` component). Requires enabling (or deleting) + * `View controller-based status bar appearance` in your Info.plist file and having `react-native-screens` enabled. + * On Android, requires `react-native-screens` version >=3.3.0. */ statusBarAnimation?: 'none' | 'fade' | 'slide'; /** - * Sets the status bar color (similar to the `StatusBar` component). Requires enabled `react-native-screens` version >=3.3.0. + * Sets the status bar color (similar to the `StatusBar` component). + * Requires enabled `react-native-screens` version >=3.3.0. * * @platform android */ statusBarColor?: string; /** - * Whether the status bar should be hidden on this screen. Requires enabling (or deleting) `View controller-based status bar appearance` in your Info.plist file and having `react-native-screens` enabled. On Android, requires `react-native-screens` version >=3.3.0. + * Whether the status bar should be hidden on this screen. Requires enabling (or deleting) + * `View controller-based status bar appearance` in your Info.plist file and having `react-native-screens` enabled. + * On Android, requires `react-native-screens` version >=3.3.0. */ statusBarHidden?: boolean; /** - * Sets the status bar color (similar to the `StatusBar` component). Requires enabling (or deleting) `View controller-based status bar appearance` in your Info.plist file and having `react-native-screens` enabled. On Android, requires `react-native-screens` version >=3.3.0. + * Sets the status bar color (similar to the `StatusBar` component). Requires enabling (or deleting) + * `View controller-based status bar appearance` in your Info.plist file and having `react-native-screens` enabled. + * On Android, requires `react-native-screens` version >=3.3.0. */ statusBarStyle?: 'inverted' | 'auto' | 'light' | 'dark'; /** diff --git a/packages/drawer/src/types.tsx b/packages/drawer/src/types.tsx index bed083ad..e380f3a5 100644 --- a/packages/drawer/src/types.tsx +++ b/packages/drawer/src/types.tsx @@ -52,6 +52,7 @@ export type DrawerNavigationConfig = { export type NativeScreenTraitsProps = { /** * In which orientation should the screen appear. It requires having `react-native-screens` enabled. + * On Android, requires `react-native-screens` version >=3.3.0. * The following values are currently supported: * - "default" - resolves to "all" without "portrait_down" on iOS. On Android, this lets the system decide the best orientation. * - "all" – all orientations are permitted @@ -72,21 +73,28 @@ export type NativeScreenTraitsProps = { | 'landscape_left' | 'landscape_right'; /** - * Sets the status bar animation (similar to the `StatusBar` component). Requires enabling (or deleting) `View controller-based status bar appearance` in your Info.plist file and having `react-native-screens` enabled. On Android, requires `react-native-screens` version >=3.3.0. + * Sets the status bar animation (similar to the `StatusBar` component). Requires enabling (or deleting) + * `View controller-based status bar appearance` in your Info.plist file and having `react-native-screens` enabled. + * On Android, requires `react-native-screens` version >=3.3.0. */ statusBarAnimation?: 'none' | 'fade' | 'slide'; /** - * Sets the status bar color (similar to the `StatusBar` component). Requires enabled `react-native-screens` version >=3.3.0. + * Sets the status bar color (similar to the `StatusBar` component). + * Requires enabled `react-native-screens` version >=3.3.0. * * @platform android */ statusBarColor?: string; /** - * Whether the status bar should be hidden on this screen. Requires enabling (or deleting) `View controller-based status bar appearance` in your Info.plist file and having `react-native-screens` enabled. On Android, requires `react-native-screens` version >=3.3.0. + * Whether the status bar should be hidden on this screen. Requires enabling (or deleting) + * `View controller-based status bar appearance` in your Info.plist file and having `react-native-screens` enabled. + * On Android, requires `react-native-screens` version >=3.3.0. */ statusBarHidden?: boolean; /** - * Sets the status bar color (similar to the `StatusBar` component). Requires enabling (or deleting) `View controller-based status bar appearance` in your Info.plist file and having `react-native-screens` enabled. On Android, requires `react-native-screens` version >=3.3.0. + * Sets the status bar color (similar to the `StatusBar` component). Requires enabling (or deleting) + * `View controller-based status bar appearance` in your Info.plist file and having `react-native-screens` enabled. + * On Android, requires `react-native-screens` version >=3.3.0. */ statusBarStyle?: 'inverted' | 'auto' | 'light' | 'dark'; /** diff --git a/packages/stack/src/types.tsx b/packages/stack/src/types.tsx index 11f51894..b3436979 100644 --- a/packages/stack/src/types.tsx +++ b/packages/stack/src/types.tsx @@ -202,6 +202,7 @@ export type StackDescriptorMap = Record; export type NativeScreenTraitsProps = { /** * In which orientation should the screen appear. It requires having `react-native-screens` enabled. + * On Android, requires `react-native-screens` version >=3.3.0. * The following values are currently supported: * - "default" - resolves to "all" without "portrait_down" on iOS. On Android, this lets the system decide the best orientation. * - "all" – all orientations are permitted @@ -222,21 +223,28 @@ export type NativeScreenTraitsProps = { | 'landscape_left' | 'landscape_right'; /** - * Sets the status bar animation (similar to the `StatusBar` component). Requires enabling (or deleting) `View controller-based status bar appearance` in your Info.plist file and having `react-native-screens` enabled. On Android, requires `react-native-screens` version >=3.3.0. + * Sets the status bar animation (similar to the `StatusBar` component). Requires enabling (or deleting) + * `View controller-based status bar appearance` in your Info.plist file and having `react-native-screens` enabled. + * On Android, requires `react-native-screens` version >=3.3.0. */ statusBarAnimation?: 'none' | 'fade' | 'slide'; /** - * Sets the status bar color (similar to the `StatusBar` component). Requires enabled `react-native-screens` version >=3.3.0. + * Sets the status bar color (similar to the `StatusBar` component). + * Requires enabled `react-native-screens` version >=3.3.0. * * @platform android */ statusBarColor?: string; /** - * Whether the status bar should be hidden on this screen. Requires enabling (or deleting) `View controller-based status bar appearance` in your Info.plist file and having `react-native-screens` enabled. On Android, requires `react-native-screens` version >=3.3.0. + * Whether the status bar should be hidden on this screen. Requires enabling (or deleting) + * `View controller-based status bar appearance` in your Info.plist file and having `react-native-screens` enabled. + * On Android, requires `react-native-screens` version >=3.3.0. */ statusBarHidden?: boolean; /** - * Sets the status bar color (similar to the `StatusBar` component). Requires enabling (or deleting) `View controller-based status bar appearance` in your Info.plist file and having `react-native-screens` enabled. On Android, requires `react-native-screens` version >=3.3.0. + * Sets the status bar color (similar to the `StatusBar` component). Requires enabling (or deleting) + * `View controller-based status bar appearance` in your Info.plist file and having `react-native-screens` enabled. + * On Android, requires `react-native-screens` version >=3.3.0. */ statusBarStyle?: 'inverted' | 'auto' | 'light' | 'dark'; /**