Skip to content

docs: add overrideScrollViewContentInsetAdjustmentBehavior option to bottom tab navigator #1492

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

Open
dobomode wants to merge 1 commit into
base: main
Choose a base branch
from
+40 −0
Open

docs: add overrideScrollViewContentInsetAdjustmentBehavior option to bottom tab navigator #1492

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
20 changes: 20 additions & 0 deletions versioned_docs/version-7.x/native-bottom-tab-navigator.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -503,6 +503,26 @@ When `false`, tapping on the tab in tab bar won't select the tab. Custom behavio

Defaults to `true`.

#### `overrideScrollViewContentInsetAdjustmentBehavior`

Whether to override the `contentInsetAdjustmentBehavior` of the first `ScrollView` in the first descendant chain from the tab screen.

By default, React Native's `ScrollView` has `contentInsetAdjustmentBehavior` set to `never` instead of the UIKit default (`automatic`), which prevents `ScrollView`s from respecting navigation bar insets. When this option is `true`, that override is applied, restoring UIKit's `automatic` behavior for the first descendant `ScrollView`.

Defaults to `true`. To disable for specific screens — for example to fix a blank gap appearing above content in a nested native-stack screen that uses `headerTransparent: true` — set the option to `false`:

```js
<Tab.Screen
name="Journal"
component={JournalStackNavigator}
options={{
overrideScrollViewContentInsetAdjustmentBehavior: false,
}}
/>
```

Only supported on iOS.

#### `bottomAccessory`

Function that returns a React element to display as an accessory view. The function receives an options object with a `placement` parameter that can be one of the following values:
Expand Down
20 changes: 20 additions & 0 deletions versioned_docs/version-8.x/bottom-tab-navigator.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1043,6 +1043,26 @@ When `false`, tapping on the tab in tab bar won't select the tab. Custom behavio

Defaults to `true`.

#### `overrideScrollViewContentInsetAdjustmentBehavior`

Whether to override the `contentInsetAdjustmentBehavior` of the first `ScrollView` in the first descendant chain from the tab screen.

By default, React Native's `ScrollView` has `contentInsetAdjustmentBehavior` set to `never` instead of the UIKit default (`automatic`), which prevents `ScrollView`s from respecting navigation bar insets. When this option is `true`, that override is applied, restoring UIKit's `automatic` behavior for the first descendant `ScrollView`.

Defaults to `true`. To disable for specific screens — for example to fix a blank gap appearing above content in a nested native-stack screen that uses `headerTransparent: true` — set the option to `false`:

```js
<Tab.Screen
name="Journal"
component={JournalStackNavigator}
options={{
overrideScrollViewContentInsetAdjustmentBehavior: false,
}}
/>
```

Only supported on iOS.

#### `bottomAccessory`

Function that returns a React element to display as an accessory view. The function receives an options object with a `placement` parameter that can be one of the following values:
Expand Down
Loading