Skip to content

Commit dec46bd

Browse files
committed
Update native stack sheet docs for 8.x
1 parent 6ecfdc2 commit dec46bd

File tree

1 file changed

+44
-0
lines changed

1 file changed

+44
-0
lines changed

versioned_docs/version-8.x/native-stack-navigator.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -560,10 +560,54 @@ Additionaly there are following options available:
560560
- `none` - there will be dimming view for all detents levels,
561561
- `last` - there won't be a dimming view for any detent level.
562562

563+
:::warning
564+
565+
On iOS, the native implementation might resize the the sheet w/o explicitly changing the detent level, e.g. in case of keyboard appearance.
566+
567+
In case after such resize the sheet exceeds height for which in regular scenario a dimming view would be applied - it will be applied, even if the detent has not effectively been changed.
568+
569+
:::
570+
563571
Defaults to `none`, indicating that the dimming view should be always present.
564572

565573
Only supported on Android and iOS.
566574

575+
#### `sheetShouldOverflowTopInset`
576+
577+
:::note
578+
579+
Works only when `presentation` is set to `formSheet`.
580+
581+
:::
582+
583+
Boolean indicating whether the sheet content should be rendered behind the **status bar** or **display cutouts**.
584+
585+
When set to `true`, the sheet will extend to the physical edges of the stack, allowing content to be visible behind the status bar or display cutouts. Detent ratios in `sheetAllowedDetents` will be measured relative to the **full stack height**.
586+
587+
When set to `false`, the sheet's layout will be constrained by the inset from the top and the detent ratios will then be measured relative to the **adjusted height** (excluding the top inset). This means that `sheetAllowedDetents` will result in different sheet heights depending on this prop.
588+
589+
Defaults to `false`.
590+
591+
Only supported on Android.
592+
593+
#### `sheetResizeAnimationEnabled`
594+
595+
:::note
596+
597+
Works only when `presentation` is set to `formSheet`.
598+
599+
:::
600+
601+
Boolean indicating whether the default native animation should be used when the sheet's content size changes (specifically when using `fitToContents`).
602+
603+
When set to `true`, the sheet uses internal logic to synchronize size updates and translation animations during entry, exit, or content updates. This ensures a smooth transition for standard, static content mounting/unmounting.
604+
605+
When set to `false`, the internal animation and translation logic is ignored. This allows the sheet to adjust its size dynamically based on the current dimensions of the content provided by the developer, allowing implementing **custom resizing animations**.
606+
607+
Defaults to `true`.
608+
609+
Only supported on Android.
610+
567611
#### `orientation`
568612

569613
The display orientation to use for the screen.

0 commit comments

Comments
 (0)