Skip to content

docs: update information in native-stack's README and guide for library authors #2851

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
kligarski merged 3 commits into from
Apr 9, 2025
Merged

docs: update information in native-stack's README and guide for library authors #2851

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4f07102
add deprecation message to some status/navigation bar related props i…
kligarski Apr 9, 2025
dd83ee7
fix typo
kligarski Apr 9, 2025
a4b3847
update information about formSheet on Android
kligarski Apr 9, 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
10 changes: 9 additions & 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 @@ -96,6 +96,8 @@ Defaults to `false`.

### `navigationBarColor` (Android only)

This prop is **deprecated**. See [here](https://developer.android.com/about/versions/15/behavior-changes-15#ux).

Sets the navigation bar color. Defaults to initial status bar color.

### `navigationBarHidden` (Android only)
Expand Down Expand Up @@ -261,7 +263,9 @@ For iOS:

For Android:

`modal`, `containedModal`, `fullScreenModal`, `formSheet`, `pageSheet` will use `Screen.StackPresentation.MODAL`.
`modal`, `containedModal`, `fullScreenModal`, `pageSheet` will use `Screen.StackPresentation.MODAL`.

`formSheet` will use `Screen.StackPresentation.FORM_SHEET`.

`transparentModal`, `containedTransparentModal` will use `Screen.StackPresentation.TRANSPARENT_MODAL`.

Expand All @@ -273,6 +277,8 @@ Defaults to `fade` on iOS and `none` on Android.

### `statusBarColor` (Android only)

This prop is **deprecated**. See [here](https://developer.android.com/about/versions/15/behavior-changes-15#ux).

Sets the status bar color (similar to the `StatusBar` component). Defaults to initial status bar color.

### `statusBarHidden`
Expand All @@ -289,6 +295,8 @@ Defaults to `auto`.

### `statusBarTranslucent` (Android only)

This prop is **deprecated**. See [here](https://developer.android.com/about/versions/15/behavior-changes-15#ux).

Sets the translucency of the status bar (similar to the `StatusBar` component). Defaults to `false`.

### `swipeDirection` (iOS only)
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 @@ -349,7 +349,7 @@ How the screen should be presented. Possible values:
- `containedModal` – will use "UIModalPresentationCurrentContext" modal style on iOS and will fallback to `"modal"` on Android.
- `containedTransparentModal` – will use "UIModalPresentationOverCurrentContext" modal style on iOS and will fallback to `"transparentModal"` on Android.
- `fullScreenModal` – will use "UIModalPresentationFullScreen" modal style on iOS and will fallback to `"modal"` on Android.
- `formSheet` – will use "UIModalPresentationFormSheet" modal style on iOS and will fallback to `"modal"` on Android.
- `formSheet` – will use "UIModalPresentationFormSheet" modal style on iOS and "BottomSheetBehavior" on Android.
- `pageSheet` – will use "UIModalPresentationPageSheet" modal style on iOS and will fallback to `"modal"` on Android.

Defaults to `push`.
Expand Down
2 changes: 1 addition & 1 deletion src/types.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -188,7 +188,7 @@ export interface ScreenProps extends ViewProps {
*
* @deprecated For all apps targeting Android SDK 35 or above this prop has no effect and is subject to removal in the future.
* For SDK below 35 this works only with specific app setup.
* This props is subject to removal in the future.
* This prop is subject to removal in the future.
* See: https://developer.android.com/reference/android/view/Window#setNavigationBarColor(int)
*/
navigationBarColor?: ColorValue;
Expand Down
Loading