docs: add overrideScrollViewContentInsetAdjustmentBehavior option to bottom tab navigator#1492
Open
dobomode wants to merge 1 commit into
Open
Conversation
…bottom tab navigator Closes react-navigation#1491 The option has been exposed on Tab.Screen since react-native-screens v3 (via @react-navigation/bottom-tabs/unstable types), but isn't listed on the docs page. It's the only escape hatch for a fairly common visible bug — a blank gap appearing above content in a nested native-stack screen that uses headerTransparent: true on iOS — and readers hitting the symptom have no way to discover it from the documentation. Added to v7 (native-bottom-tab-navigator.md) and v8 (bottom-tab-navigator.md). Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
✅ Deploy Preview for react-navigation-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #1491.
Summary
The
overrideScrollViewContentInsetAdjustmentBehavioroption has been exposed onTab.Screenvia@react-navigation/bottom-tabs/unstabletypes (source) sincereact-native-screensstarted exposing it natively. It's iOS-only, defaults totrue, and currently has no entry on the public docs site — only the JSDoc in the TypeScript source.It's the only escape hatch for a fairly common visible symptom on iOS:
Reported with the same symptom in react-navigation/react-navigation#12946; the option was added in response but never landed in the docs.
Changes
Added a new option section between
tabBarSelectionEnabledandbottomAccessoryin:versioned_docs/version-7.x/native-bottom-tab-navigator.mdversioned_docs/version-8.x/bottom-tab-navigator.mdThe wording mirrors the existing JSDoc and includes a minimal code example showing how to disable the override on a specific tab.
Test plan