react-navigation / react-navigation/react-navigation.github.io
Docs: `overrideScrollViewContentInsetAdjustmentBehavior` option missing from Native Bottom Tab Navigator page
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 324
- Forks
- 2k
- PR merge metrics
- No merged PRs in 30d
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
contentInsetAdjustmentBehaviorof the firstScrollViewin the first descendant chain from the tab screen.By default,
react-native'sScrollViewhascontentInsetAdjustmentBehaviorset toneverinstead of UIKit-default (which isautomatic). This prevents ScrollViews from respecting navigation bar insets. When this prop is set totrue,automaticbehavior is reverted.To disable this behavior for specific screens, set this option to
false.Only supported with
nativeimplementation.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.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
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.
Assessment
- Tech stack
- react-native
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Quiet
- Clarity
- Clearly specified
- Newbie friendliness
- 90/100