Skip to content

Commit a6fd3d9

Browse files
authored
docs: update information in native-stack's README and guide for library authors (#2851)
## Description Small changes in docs. ## Changes - add deprecation messages to navigation/status bar related props deprecated in #2638 in `GUIDE_FOR_LIBRARY_AUTHORS.md` - fix typo in `src/types.tsx` - update information about `formSheet` in `GUIDE_FOR_LIBRARY_AUTHORS.md`
1 parent 4eb5379 commit a6fd3d9

3 files changed

Lines changed: 11 additions & 3 deletions

File tree

guides/GUIDE_FOR_LIBRARY_AUTHORS.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,8 @@ Defaults to `false`.
9696

9797
### `navigationBarColor` (Android only)
9898

99+
This prop is **deprecated**. See [here](https://developer.android.com/about/versions/15/behavior-changes-15#ux).
100+
99101
Sets the navigation bar color. Defaults to initial status bar color.
100102

101103
### `navigationBarHidden` (Android only)
@@ -261,7 +263,9 @@ For iOS:
261263

262264
For Android:
263265

264-
`modal`, `containedModal`, `fullScreenModal`, `formSheet`, `pageSheet` will use `Screen.StackPresentation.MODAL`.
266+
`modal`, `containedModal`, `fullScreenModal`, `pageSheet` will use `Screen.StackPresentation.MODAL`.
267+
268+
`formSheet` will use `Screen.StackPresentation.FORM_SHEET`.
265269

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

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

274278
### `statusBarColor` (Android only)
275279

280+
This prop is **deprecated**. See [here](https://developer.android.com/about/versions/15/behavior-changes-15#ux).
281+
276282
Sets the status bar color (similar to the `StatusBar` component). Defaults to initial status bar color.
277283

278284
### `statusBarHidden`
@@ -289,6 +295,8 @@ Defaults to `auto`.
289295

290296
### `statusBarTranslucent` (Android only)
291297

298+
This prop is **deprecated**. See [here](https://developer.android.com/about/versions/15/behavior-changes-15#ux).
299+
292300
Sets the translucency of the status bar (similar to the `StatusBar` component). Defaults to `false`.
293301

294302
### `swipeDirection` (iOS only)

native-stack/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -349,7 +349,7 @@ How the screen should be presented. Possible values:
349349
- `containedModal` – will use "UIModalPresentationCurrentContext" modal style on iOS and will fallback to `"modal"` on Android.
350350
- `containedTransparentModal` – will use "UIModalPresentationOverCurrentContext" modal style on iOS and will fallback to `"transparentModal"` on Android.
351351
- `fullScreenModal` – will use "UIModalPresentationFullScreen" modal style on iOS and will fallback to `"modal"` on Android.
352-
- `formSheet` – will use "UIModalPresentationFormSheet" modal style on iOS and will fallback to `"modal"` on Android.
352+
- `formSheet` – will use "UIModalPresentationFormSheet" modal style on iOS and "BottomSheetBehavior" on Android.
353353
- `pageSheet` – will use "UIModalPresentationPageSheet" modal style on iOS and will fallback to `"modal"` on Android.
354354

355355
Defaults to `push`.

src/types.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -188,7 +188,7 @@ export interface ScreenProps extends ViewProps {
188188
*
189189
* @deprecated For all apps targeting Android SDK 35 or above this prop has no effect and is subject to removal in the future.
190190
* For SDK below 35 this works only with specific app setup.
191-
* This props is subject to removal in the future.
191+
* This prop is subject to removal in the future.
192192
* See: https://developer.android.com/reference/android/view/Window#setNavigationBarColor(int)
193193
*/
194194
navigationBarColor?: ColorValue;

0 commit comments

Comments
 (0)