fix: fix refs handling for custom scrollables#20
Merged
Conversation
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
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.
Summary
This PR fixes scroll synchronization in pager-style multi-tab setups when using third-party list wrappers like FlashList and LegendList.
The root issue was that these libraries expose an outer ref that is not the actual native scroll view Reanimated should drive for imperative scroll synchronization. In that scenario, header state could remain visually collapsed while the underlying list offset was still stale, which caused a jump as soon as the user started dragging again after switching tabs.
What changed
managedRefTargettocreateHeaderMotionScrollable()so custom wrappers can explicitly choose whether Header Motion should synchronize against the outer scrollable ref or the injected inner scroll component.'outer', preserving backward compatibility and existing behavior for built-inFlatListand other current wrappers.managedRefTargetis'inner', the wrapper keeps the user-providedanimatedRefon the outer componentuseScrollManager()is allowed to fall back to its own internal refScrollablePresetsfor common third-party integrations:ScrollablePresets.FlashListScrollablePresets.AnimatedLegendListmanagedRefTargetis only available whencontentContainerModeisrenderScrollComponent.ScrollablePresets.Examples
ScrollablePresets.FlatListbehavior unchanged.Docs
Updated the docs to reflect the new API and recommended usage:
ScrollablePresetsis now documented as the preferred path for FlashList and LegendListmanagedRefTargetis documented as a render-scroll-component-only optionVerification
createHeaderMotionScrollable()FlatListtests still pass