diff --git a/packages/bottom-tabs/src/types.tsx b/packages/bottom-tabs/src/types.tsx index 3dbf155c..8985eefe 100644 --- a/packages/bottom-tabs/src/types.tsx +++ b/packages/bottom-tabs/src/types.tsx @@ -103,25 +103,25 @@ 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. + * 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). It requires having `react-native-screens` enabled. + * 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. + * 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. + * 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'; /** - * Sets the translucency of the status bar. Defaults to true. It requires having `react-native-screens` enabled. + * Sets the translucency of the status bar. Defaults to true. Requires enabled `react-native-screens` version >=3.3.0. * * @platform android */ diff --git a/packages/drawer/src/types.tsx b/packages/drawer/src/types.tsx index 359f387d..bed083ad 100644 --- a/packages/drawer/src/types.tsx +++ b/packages/drawer/src/types.tsx @@ -72,25 +72,25 @@ 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. + * 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). It requires having `react-native-screens` enabled. + * 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. + * 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. + * 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'; /** - * Sets the translucency of the status bar. Defaults to true. It requires having `react-native-screens` enabled. + * Sets the translucency of the status bar. Defaults to true. Requires enabled `react-native-screens` version >=3.3.0. * * @platform android */ diff --git a/packages/native-stack/src/types.tsx b/packages/native-stack/src/types.tsx index aa2c0999..239e9c28 100644 --- a/packages/native-stack/src/types.tsx +++ b/packages/native-stack/src/types.tsx @@ -345,10 +345,12 @@ export type NativeStackNavigationOptions = { /** * Sets the status bar animation (similar to the `StatusBar` component). * Requires setting `View controller-based status bar appearance -> YES` (or removing the config) in your `Info.plist` file. + * On Android, requires `react-native-screens` version >=3.3.0. */ statusBarAnimation?: StatusBarAnimationTypes; /** * Sets the status bar color (similar to the `StatusBar` component). Defaults to initial status bar color. + * Requires `react-native-screens` version >=3.3.0. * * @platform android */ @@ -356,15 +358,19 @@ export type NativeStackNavigationOptions = { /** * Whether the status bar should be hidden on this screen. * Requires setting `View controller-based status bar appearance -> YES` in your Info.plist file. + * On Android, requires `react-native-screens` version >=3.3.0. */ statusBarHidden?: boolean; /** * Sets the status bar color (similar to the `StatusBar` component). * Requires setting `View controller-based status bar appearance -> YES` (or removing the config) in your `Info.plist` file. + * On Android, requires `react-native-screens` version >=3.3.0. */ statusBarStyle?: StatusBarStyleTypes; /** * Sets the translucency of the status bar. Defaults to `false`. + * Requires `react-native-screens` version >=3.3.0. + * * @platform android */ statusBarTranslucent?: boolean; diff --git a/packages/stack/src/types.tsx b/packages/stack/src/types.tsx index 98db11c2..11f51894 100644 --- a/packages/stack/src/types.tsx +++ b/packages/stack/src/types.tsx @@ -222,25 +222,25 @@ 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. + * 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). It requires having `react-native-screens` enabled. + * 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. + * 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. + * 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'; /** - * Sets the translucency of the status bar. Defaults to true. It requires having `react-native-screens` enabled. + * Sets the translucency of the status bar. Defaults to true. Requires enabled `react-native-screens` version >=3.3.0. * * @platform android */