Skip to content

docs: add missing information about status bar props #2953

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jun 6, 2025
Merged

docs: add missing information about status bar props #2953

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
fba1818
add information about statusBarStyle on Android, fix missing parenthe…
kligarski May 29, 2025
b5e464e
update statusBarAnimation docs
kligarski Jun 2, 2025
986ced9
remove changes from native-stack files
kligarski Jun 2, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion guides/GUIDE_FOR_LIBRARY_AUTHORS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -289,7 +289,7 @@ Defaults to `false`.

### `statusBarStyle`

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. On iOS, the possible values are: `auto` (based on [user interface style](https://developer.apple.com/documentation/uikit/uiuserinterfacestyle?language=objc), `inverted` (colors opposite to `auto`), `light`, `dark`. On Android, the status bar will be dark if set to `dark` and `light` otherwise.
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. On iOS, the possible values are: `auto` (based on [user interface style](https://developer.apple.com/documentation/uikit/uiuserinterfacestyle?language=objc)), `inverted` (colors opposite to `auto`), `light`, `dark`. On Android, the status bar will be dark if set to `dark` and `light` otherwise.

Defaults to `auto`.

Expand Down
2 changes: 1 addition & 1 deletion native-stack/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -503,7 +503,7 @@ Defaults to `false`.

#### `statusBarStyle`

Sets the status bar color (similar to the `StatusBar` component). On iOS, the possible values are: `auto` (based on [user interface style](https://developer.apple.com/documentation/uikit/uiuserinterfacestyle?language=objc), `inverted` (colors opposite to `auto`), `light`, `dark`. On Android, the status bar will be dark if set to `dark` and `light` otherwise.
Sets the status bar color (similar to the `StatusBar` component). On iOS, the possible values are: `auto` (based on [user interface style](https://developer.apple.com/documentation/uikit/uiuserinterfacestyle?language=objc)), `inverted` (colors opposite to `auto`), `light`, `dark`. On Android, the status bar will be dark if set to `dark` and `light` otherwise.

Defaults to `auto`.

Expand Down
10 changes: 8 additions & 2 deletions src/native-stack/types.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -485,7 +485,11 @@ export type NativeStackNavigationOptions = {
*/
stackPresentation?: ScreenProps['stackPresentation'];
/**
* 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.
* Sets the status bar animation (similar to the `StatusBar` component).
* 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.
* Requires enabling (or deleting) `View controller-based status bar appearance` in your Info.plist file on iOS.
*
* Defaults to `fade` on iOS and `none` on Android.
*/
statusBarAnimation?: ScreenProps['statusBarAnimation'];
/**
Expand All @@ -499,7 +503,9 @@ export type NativeStackNavigationOptions = {
*/
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 on iOS. Defaults to `auto`.
* 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 on iOS.
* `auto` and `inverted` are supported only on iOS. On Android, they will fallback to `light`.
* Defaults to `auto` on iOS and `light` on Android.
*/
statusBarStyle?: ScreenProps['statusBarStyle'];
/**
Expand Down
10 changes: 8 additions & 2 deletions src/types.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -430,7 +430,11 @@ export interface ScreenProps extends ViewProps {
*/
stackPresentation?: StackPresentationTypes;
/**
* 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.
* Sets the status bar animation (similar to the `StatusBar` component).
* 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.
* Requires enabling (or deleting) `View controller-based status bar appearance` in your Info.plist file on iOS.
*
* Defaults to `fade` on iOS and `none` on Android.
*/
statusBarAnimation?: 'none' | 'fade' | 'slide';
/**
Expand All @@ -449,7 +453,9 @@ export interface ScreenProps extends ViewProps {
*/
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 on iOS. Defaults to `auto`.
* 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 on iOS.
* `auto` and `inverted` are supported only on iOS. On Android, they will fallback to `light`.
* Defaults to `auto` on iOS and `light` on Android.
*/
statusBarStyle?: 'inverted' | 'auto' | 'light' | 'dark';
/**
Expand Down
Loading