Skip to content

Commit d7ca881

Browse files
authored
docs: add missing information in status bar docs (#12618)
**Motivation** Recently noticed that docs for `statusBarStyle` and `statusBarHidden` are not kept in sync between files in `react-native-screens` repo, `react-naviagtion` in-code docs and `reactnavigation.org/docs`. I added information about support on Android for `statusBarStyle` and `statusBarHidden` props and `auto` and `inverted` values not being supported on Android for `statusBarStyle`. Similar PR in `react-native-screens`: software-mansion/react-native-screens#2953, `react-navigation.github.io`: react-navigation/react-navigation.github.io#1432.
1 parent 9739421 commit d7ca881

File tree

1 file changed

+7
-4
lines changed

1 file changed

+7
-4
lines changed

packages/native-stack/src/types.tsx

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -425,18 +425,21 @@ export type NativeStackNavigationOptions = {
425425
* Whether the status bar should be hidden on this screen.
426426
* Requires setting `View controller-based status bar appearance -> YES` in your Info.plist file.
427427
*
428-
* Only supported on iOS.
428+
* Only supported on Android and iOS.
429429
*
430-
* @platform ios
430+
* @platform android, ios
431431
*/
432432
statusBarHidden?: boolean;
433433
/**
434434
* Sets the status bar color (similar to the `StatusBar` component).
435435
* Requires setting `View controller-based status bar appearance -> YES` (or removing the config) in your `Info.plist` file.
436+
* `auto` and `inverted` are supported only on iOS. On Android, they will fallback to `light`.
436437
*
437-
* Only supported on iOS.
438+
* Defaults to `auto` on iOS and `light` on Android.
438439
*
439-
* @platform ios
440+
* Only supported on Android and iOS.
441+
*
442+
* @platform android, ios
440443
*/
441444
statusBarStyle?: ScreenProps['statusBarStyle'];
442445
/**

0 commit comments

Comments
 (0)