Skip to content

Commit b5e464e

Browse files
committed
update statusBarAnimation docs
1 parent fba1818 commit b5e464e

2 files changed

Lines changed: 10 additions & 2 deletions

File tree

src/native-stack/types.tsx

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -485,7 +485,11 @@ export type NativeStackNavigationOptions = {
485485
*/
486486
stackPresentation?: ScreenProps['stackPresentation'];
487487
/**
488-
* 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 on iOS.
488+
* Sets the status bar animation (similar to the `StatusBar` component).
489+
* On Android, setting either `fade` or `slide` will set the transition of status bar color. On iOS, this option applies to appereance animation of the status bar.
490+
* Requires enabling (or deleting) `View controller-based status bar appearance` in your Info.plist file on iOS.
491+
*
492+
* Defaults to `fade` on iOS and `none` on Android.
489493
*/
490494
statusBarAnimation?: ScreenProps['statusBarAnimation'];
491495
/**

src/types.tsx

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -430,7 +430,11 @@ export interface ScreenProps extends ViewProps {
430430
*/
431431
stackPresentation?: StackPresentationTypes;
432432
/**
433-
* 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 on iOS.
433+
* Sets the status bar animation (similar to the `StatusBar` component).
434+
* On Android, setting either `fade` or `slide` will set the transition of status bar color. On iOS, this option applies to appereance animation of the status bar.
435+
* Requires enabling (or deleting) `View controller-based status bar appearance` in your Info.plist file on iOS.
436+
*
437+
* Defaults to `fade` on iOS and `none` on Android.
434438
*/
435439
statusBarAnimation?: 'none' | 'fade' | 'slide';
436440
/**

0 commit comments

Comments
 (0)