[TabLayout] Fix scrolling issue when using scrollable tab layout with…

… viewpager Resolves #3138 PiperOrigin-RevId: 508444050
material-components · Feb 9, 2023 · e9246ed · e9246ed
1 parent 505460f
commit e9246ed
Show file tree

Hide file tree

Showing 2 changed files with 46 additions and 3 deletions.
diff --git a/lib/java/com/google/android/material/tabs/TabLayout.java b/lib/java/com/google/android/material/tabs/TabLayout.java
@@ -757,6 +757,20 @@ public void setScrollPosition(
       float positionOffset,
       boolean updateSelectedTabView,
       boolean updateIndicatorPosition) {
+    setScrollPosition(
+        position,
+        positionOffset,
+        updateSelectedTabView,
+        updateIndicatorPosition,
+        /* alwaysScroll= */ true);
+  }
+
+  void setScrollPosition(
+      int position,
+      float positionOffset,
+      boolean updateSelectedTabView,
+      boolean updateIndicatorPosition,
+      boolean alwaysScroll) {
     final int roundedPosition = Math.round(position + positionOffset);
     if (roundedPosition < 0 || roundedPosition >= slidingTabIndicator.getChildCount()) {
       return;
@@ -771,7 +785,36 @@ public void setScrollPosition(
     if (scrollAnimator != null && scrollAnimator.isRunning()) {
       scrollAnimator.cancel();
     }
-    scrollTo(position < 0 ? 0 : calculateScrollXForTab(position, positionOffset), 0);
+    int scrollXForPosition = calculateScrollXForTab(position, positionOffset);
+    int scrollX = getScrollX();
+    // If the position is smaller than the selected tab position, the position is getting larger
+    // to reach the selected tab position so scrollX is increasing.
+    // We only want to update the scroll position if the new scroll position is greater than
+    // the current scroll position.
+    // Conversely if the position is greater than the selected tab position, the position is
+    // getting smaller to reach the selected tab position so scrollX is decreasing.
+    // We only update the scroll position if the new scroll position is less than the current
+    // scroll position.
+    // Lastly if the position is equal to the selected position, we want to set the scroll
+    // position which also updates the selected tab view and the indicator.
+    boolean toMove =
+        (position < getSelectedTabPosition() && scrollXForPosition >= scrollX)
+            || (position > getSelectedTabPosition() && scrollXForPosition <= scrollX)
+            || (position == getSelectedTabPosition());
+    // If the layout direction is RTL, the scrollXForPosition and scrollX comparisons are
+    // reversed since scrollX values remain the same in RTL but tab positions go RTL.
+    if (ViewCompat.getLayoutDirection(this) == ViewCompat.LAYOUT_DIRECTION_RTL) {
+      toMove =
+          (position < getSelectedTabPosition() && scrollXForPosition <= scrollX)
+              || (position > getSelectedTabPosition()
+              && scrollXForPosition >= scrollX)
+              || (position == getSelectedTabPosition());
+    }
+    // We want to scroll if alwaysScroll is true, the viewpager is being dragged, or if we should
+    // scroll by the rules above.
+    if (toMove || viewPagerScrollState == SCROLL_STATE_DRAGGING || alwaysScroll) {
+      scrollTo(position < 0 ? 0 : scrollXForPosition, 0);
+    }
 
     // Update the 'selected state' view as we scroll, if enabled
     if (updateSelectedTabView) {
@@ -3536,7 +3579,7 @@ public void onPageScrolled(
         final boolean updateIndicator =
             !(scrollState == SCROLL_STATE_SETTLING && previousScrollState == SCROLL_STATE_IDLE);
         tabLayout.setScrollPosition(
-            position, positionOffset, updateSelectedTabView, updateIndicator);
+            position, positionOffset, updateSelectedTabView, updateIndicator, false);
       }
     }
 

diff --git a/lib/java/com/google/android/material/tabs/TabLayoutMediator.java b/lib/java/com/google/android/material/tabs/TabLayoutMediator.java
@@ -230,7 +230,7 @@ public void onPageScrolled(int position, float positionOffset, int positionOffse
         boolean updateIndicator =
             !(scrollState == SCROLL_STATE_SETTLING && previousScrollState == SCROLL_STATE_IDLE);
         tabLayout.setScrollPosition(
-            position, positionOffset, updateSelectedTabView, updateIndicator);
+            position, positionOffset, updateSelectedTabView, updateIndicator, false);
       }
     }