Docs: `overrideScrollViewContentInsetAdjustmentBehavior` option missing from Native Bottom Tab Navigator page

Open Beginner friendly
#1,491 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
90/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Quiet
Tech stack
react-native
Domain
documentation

Research direction

Open docs/native-bottom-tab-navigator.md and read the Options section around tabBarStyle and tabBarMinimizeBehavior. Check the option's JSDoc in packages/bottom-tabs/src/unstable/types.tsx, then document its default, iOS-only and native-only limits, and the transparent-header blank-gap symptom. Done means readers can find and understand this option on the Native Bottom Tab Navigator page.

Written by the indexing model from the issue text.

Description

The Tab.Screen option overrideScrollViewContentInsetAdjustmentBehavior is implemented and exposed in @react-navigation/bottom-tabs/unstable but not listed on the Native Bottom Tab Navigator docs page.

It's an iOS-only option with non-obvious default behaviour, and it's the only escape hatch for a fairly common visible bug — a blank gap appearing above content in a native-stack screen with headerTransparent: true nested inside a NativeTabs tab. The bug was reported in #12946 and the fix is exactly this option, but a reader hitting the symptom has no way to discover it from the docs.

JSDoc from the source

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 UIKit-default (which is automatic). This prevents ScrollViews from respecting navigation bar insets. When this prop is set to true, automatic behavior is reverted.

To disable this behavior for specific screens, set this option to false.

Only supported with native implementation.

Defaults to true. iOS-only.

Suggested doc placement

Under "Options" on docs/native-bottom-tab-navigator.md, next to tabBarStyle / tabBarMinimizeBehavior (other iOS-flavoured presentation options). A brief mention of the symptom it fixes ("blank gap above content in a nested transparent-header screen on iOS") would help a lot.

Happy to PR if useful — just want to flag the gap before the next person hits it.

Dominant language
JavaScript
Stars
324
Forks
2k
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from react-navigation/react-navigation.github.io

All issues in react-navigation/react-navigation.github.io

Similar issues

More JavaScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.