Skip to content

Commit 3c7ea4f

Browse files
authored
Update docs for scrollEdgeEffects, headerBlurEffect (#1447)
1 parent f774b50 commit 3c7ea4f

File tree

1 file changed

+29
-0
lines changed

1 file changed

+29
-0
lines changed

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

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -776,6 +776,29 @@ Defaults to `true` when `enableFreeze()` from `react-native-screens` package is
776776

777777
Only supported on iOS and Android.
778778

779+
#### `scrollEdgeEffects`
780+
781+
Configures the scroll edge effect for the _content ScrollView_ (the ScrollView that is present in first descendants chain of the Screen).
782+
Depending on values set, it will blur the scrolling content below certain UI elements (e.g. header items, search bar) for the specified edge of the ScrollView.
783+
When set in nested containers, i.e. Native Stack inside Native Bottom Tabs, or the other way around, the ScrollView will use only the innermost one's config.
784+
785+
Edge effects can be configured for each edge separately. The following values are currently supported:
786+
787+
- `automatic` - the automatic scroll edge effect style,
788+
- `hard` - a scroll edge effect with a hard cutoff and dividing line,
789+
- `soft` - a soft-edged scroll edge effect,
790+
- `hidden` - no scroll edge effect.
791+
792+
Defaults to `automatic` for each edge.
793+
794+
:::note
795+
796+
Using both `blurEffect` and `scrollEdgeEffects` (>= iOS 26) simultaneously may cause overlapping effects.
797+
798+
:::
799+
800+
Only supported on iOS, starting from iOS 26.
801+
779802
### Header related options
780803

781804
The navigator supports following options to configure the header:
@@ -1015,6 +1038,12 @@ Supported values:
10151038
- `systemChromeMaterialDark`
10161039
<img src="/assets/7.x/native-stack/headerBlurEffect-systemChromeMaterialDark.png" width="500" alt="Header blur effect systemChromeMaterialDark" />
10171040

1041+
:::note
1042+
1043+
Using both `blurEffect` and `scrollEdgeEffects` (>= iOS 26) simultaneously may cause overlapping effects.
1044+
1045+
:::
1046+
10181047
Only supported on iOS.
10191048

10201049
#### `headerBackground`

0 commit comments

Comments
 (0)