Skip to content

Docs: overrideScrollViewContentInsetAdjustmentBehavior option missing from Native Bottom Tab Navigator page #1491

@dobomode

Description

@dobomode

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions