Add support for custom fading edges to LazyList/Grid/StaggeredGrid

jettbow · facebook-github-bot · commit ad5361f82ba7 · 2024-08-30T07:41:26.000-07:00
Summary: Support custom fading edges

Reviewed By: adityasharat

Differential Revision: D62023833

fbshipit-source-id: f50adcf4eb62e9b4ce520248989689cc1a48e628
diff --git a/litho-sections-widget/src/main/java/com/facebook/litho/sections/widget/RecyclerCollectionComponentSpec.java b/litho-sections-widget/src/main/java/com/facebook/litho/sections/widget/RecyclerCollectionComponentSpec.java
@@ -140,6 +140,11 @@ public class RecyclerCollectionComponentSpec {
   @PropDefault public static final boolean incrementalMount = true;
   @PropDefault public static final int refreshProgressBarColor = 0XFF4267B2; // blue
 
+  @PropDefault public static final boolean isLeftFadingEnabled = true;
+  @PropDefault public static final boolean isRightFadingEnabled = true;
+  @PropDefault public static final boolean isTopFadingEnabled = true;
+  @PropDefault public static final boolean isBottomFadingEnabled = true;
+
   @OnCreateLayout
   static @Nullable Component onCreateLayout(
       final ComponentContext c,
@@ -168,6 +173,10 @@ public class RecyclerCollectionComponentSpec {
       @Prop(optional = true) EventHandler<TouchEvent> recyclerTouchEventHandler,
       @Prop(optional = true) boolean horizontalFadingEdgeEnabled,
       @Prop(optional = true) boolean verticalFadingEdgeEnabled,
+      @Prop(optional = true) boolean isLeftFadingEnabled,
+      @Prop(optional = true) boolean isRightFadingEnabled,
+      @Prop(optional = true) boolean isTopFadingEnabled,
+      @Prop(optional = true) boolean isBottomFadingEnabled,
       @Prop(optional = true, resType = ResType.DIMEN_SIZE) int fadingEdgeLength,
       @Prop(optional = true, resType = ResType.COLOR) @Nullable
           Integer refreshProgressBarBackgroundColor,
@@ -283,6 +292,10 @@ public class RecyclerCollectionComponentSpec {
             itemDecorations,
             horizontalFadingEdgeEnabled,
             verticalFadingEdgeEnabled,
+            isLeftFadingEnabled,
+            isRightFadingEnabled,
+            isTopFadingEnabled,
+            isBottomFadingEnabled,
             fadingEdgeLength,
             edgeEffectFactory,
             recyclerViewId,
diff --git a/litho-widget-kotlin/src/main/kotlin/com/facebook/litho/widget/collection/CollectionRecyclerSpec.kt b/litho-widget-kotlin/src/main/kotlin/com/facebook/litho/widget/collection/CollectionRecyclerSpec.kt
@@ -61,6 +61,10 @@ object CollectionRecyclerSpec {
   val recyclerConfiguration: RecyclerConfiguration = ListRecyclerConfiguration.create().build()
 
   @PropDefault val itemAnimator: RecyclerView.ItemAnimator = NoUpdateItemAnimator()
+  @PropDefault val isLeftFadingEnabled: Boolean = true
+  @PropDefault val isRightFadingEnabled: Boolean = true
+  @PropDefault val isTopFadingEnabled: Boolean = true
+  @PropDefault val isBottomFadingEnabled: Boolean = true
 
   @JvmStatic
   @OnCreateLayout
@@ -84,6 +88,10 @@ object CollectionRecyclerSpec {
       @Prop(optional = true) recyclerTouchEventHandler: EventHandler<TouchEvent>?,
       @Prop(optional = true) horizontalFadingEdgeEnabled: Boolean,
       @Prop(optional = true) verticalFadingEdgeEnabled: Boolean,
+      @Prop(optional = true) isLeftFadingEnabled: Boolean,
+      @Prop(optional = true) isRightFadingEnabled: Boolean,
+      @Prop(optional = true) isTopFadingEnabled: Boolean,
+      @Prop(optional = true) isBottomFadingEnabled: Boolean,
       @Prop(optional = true, resType = ResType.DIMEN_SIZE) fadingEdgeLength: Int,
       @Prop(optional = true, resType = ResType.COLOR) refreshProgressBarBackgroundColor: Int?,
       @Prop(optional = true, resType = ResType.COLOR) refreshProgressBarColor: Int?,
@@ -151,6 +159,10 @@ object CollectionRecyclerSpec {
         itemDecorations = itemDecoration?.let { listOf(it) },
         isHorizontalFadingEdgeEnabled = horizontalFadingEdgeEnabled,
         isVerticalFadingEdgeEnabled = verticalFadingEdgeEnabled,
+        isLeftFadingEnabled = isLeftFadingEnabled,
+        isRightFadingEnabled = isRightFadingEnabled,
+        isTopFadingEnabled = isTopFadingEnabled,
+        isBottomFadingEnabled = isBottomFadingEnabled,
         fadingEdgeLength = fadingEdgeLength,
         onScrollListeners = onScrollListeners?.filterNotNull(),
         refreshProgressBarBackgroundColor = refreshProgressBarBackgroundColor,
diff --git a/litho-widget-kotlin/src/main/kotlin/com/facebook/litho/widget/collection/LazyCollection.kt b/litho-widget-kotlin/src/main/kotlin/com/facebook/litho/widget/collection/LazyCollection.kt
@@ -87,6 +87,10 @@ class LazyCollection(
     private val onDataRendered: OnDataRendered? = null,
     private val childEquivalenceIncludesCommonProps: Boolean = true,
     private val alwaysDetectDuplicates: Boolean = false,
+    private val isLeftFadingEnabled: Boolean = true,
+    private val isRightFadingEnabled: Boolean = true,
+    private val isTopFadingEnabled: Boolean = true,
+    private val isBottomFadingEnabled: Boolean = true,
     private val fadingEdgeLength: Dimen? = null,
     private val shouldExcludeFromIncrementalMount: Boolean = false,
     private val lazyCollectionChildren: LazyCollectionChildren
@@ -200,6 +204,10 @@ class LazyCollection(
             } else {
               horizontalFadingEdgeEnabled(true)
             }
+            isLeftFadingEnabled(isLeftFadingEnabled)
+            isRightFadingEnabled(isRightFadingEnabled)
+            isTopFadingEnabled(isTopFadingEnabled)
+            isBottomFadingEnabled(isBottomFadingEnabled)
           }
         }
         .kotlinStyle(style)
diff --git a/litho-widget-kotlin/src/main/kotlin/com/facebook/litho/widget/collection/LazyGrid.kt b/litho-widget-kotlin/src/main/kotlin/com/facebook/litho/widget/collection/LazyGrid.kt
@@ -67,6 +67,10 @@ inline fun ResourcesScope.LazyGrid(
     useBackgroundChangeSets: Boolean = false,
     childEquivalenceIncludesCommonProps: Boolean = true,
     alwaysDetectDuplicates: Boolean = false,
+    isLeftFadingEnabled: Boolean = true,
+    isRightFadingEnabled: Boolean = true,
+    isTopFadingEnabled: Boolean = true,
+    isBottomFadingEnabled: Boolean = true,
     fadingEdgeLength: Dimen? = null,
     preAllocationHandler: PreAllocationHandler? =
         context.lithoConfiguration.componentsConfig.preAllocationHandler,
@@ -118,6 +122,10 @@ inline fun ResourcesScope.LazyGrid(
       onDataRendered,
       childEquivalenceIncludesCommonProps,
       alwaysDetectDuplicates,
+      isLeftFadingEnabled,
+      isRightFadingEnabled,
+      isTopFadingEnabled,
+      isBottomFadingEnabled,
       fadingEdgeLength,
       shouldExcludeFromIncrementalMount,
       lazyGridScope.children)
diff --git a/litho-widget-kotlin/src/main/kotlin/com/facebook/litho/widget/collection/LazyList.kt b/litho-widget-kotlin/src/main/kotlin/com/facebook/litho/widget/collection/LazyList.kt
@@ -70,6 +70,10 @@ inline fun ResourcesScope.LazyList(
         context.lithoConfiguration.componentsConfig.preAllocationHandler,
     childEquivalenceIncludesCommonProps: Boolean = true,
     alwaysDetectDuplicates: Boolean = false,
+    isLeftFadingEnabled: Boolean = true,
+    isRightFadingEnabled: Boolean = true,
+    isTopFadingEnabled: Boolean = true,
+    isBottomFadingEnabled: Boolean = true,
     fadingEdgeLength: Dimen? = null,
     shouldExcludeFromIncrementalMount: Boolean = false,
     isCircular: Boolean = false,
@@ -123,6 +127,10 @@ inline fun ResourcesScope.LazyList(
       onDataRendered,
       childEquivalenceIncludesCommonProps,
       alwaysDetectDuplicates,
+      isLeftFadingEnabled,
+      isRightFadingEnabled,
+      isTopFadingEnabled,
+      isBottomFadingEnabled,
       fadingEdgeLength,
       shouldExcludeFromIncrementalMount,
       lazyListScope.children)
diff --git a/litho-widget-kotlin/src/main/kotlin/com/facebook/litho/widget/collection/LazyStaggeredGrid.kt b/litho-widget-kotlin/src/main/kotlin/com/facebook/litho/widget/collection/LazyStaggeredGrid.kt
@@ -70,6 +70,10 @@ inline fun ResourcesScope.LazyStaggeredGrid(
     isIncrementalMountEnabled: Boolean = true,
     childEquivalenceIncludesCommonProps: Boolean = true,
     alwaysDetectDuplicates: Boolean = false,
+    isLeftFadingEnabled: Boolean = true,
+    isRightFadingEnabled: Boolean = true,
+    isTopFadingEnabled: Boolean = true,
+    isBottomFadingEnabled: Boolean = true,
     fadingEdgeLength: Dimen? = null,
     preAllocationHandler: PreAllocationHandler? =
         context.lithoConfiguration.componentsConfig.preAllocationHandler,
@@ -124,6 +128,10 @@ inline fun ResourcesScope.LazyStaggeredGrid(
       onDataRendered,
       childEquivalenceIncludesCommonProps,
       alwaysDetectDuplicates,
+      isLeftFadingEnabled,
+      isRightFadingEnabled,
+      isTopFadingEnabled,
+      isBottomFadingEnabled,
       fadingEdgeLength,
       shouldExcludeFromIncrementalMount,
       lazyStaggeredGridScope.children)
diff --git a/litho-widget/src/main/java/com/facebook/litho/widget/LithoRecyclerView.java b/litho-widget/src/main/java/com/facebook/litho/widget/LithoRecyclerView.java
@@ -31,6 +31,10 @@
  */
 public class LithoRecyclerView extends RecyclerView implements HasPostDispatchDrawListener {
 
+  private boolean mLeftFadingEnabled = true;
+  private boolean mRightFadingEnabled = true;
+  private boolean mTopFadingEnabled = true;
+  private boolean mBottomFadingEnabled = true;
   private @Nullable TouchInterceptor mTouchInterceptor;
   private @Nullable List<PostDispatchDrawListener> mPostDispatchDrawListeners;
 
@@ -99,6 +103,58 @@ public void unregisterPostDispatchDrawListener(PostDispatchDrawListener listener
     }
   }
 
+  public void setLeftFadingEnabled(boolean leftFadingEnabled) {
+    this.mLeftFadingEnabled = leftFadingEnabled;
+  }
+
+  public void setRightFadingEnabled(boolean rightFadingEnabled) {
+    this.mRightFadingEnabled = rightFadingEnabled;
+  }
+
+  public void setTopFadingEnabled(boolean topFadingEnabled) {
+    this.mTopFadingEnabled = topFadingEnabled;
+  }
+
+  public void setBottomFadingEnabled(boolean bottomFadingEnabled) {
+    this.mBottomFadingEnabled = bottomFadingEnabled;
+  }
+
+  @Override
+  public float getLeftFadingEdgeStrength() {
+    if (mLeftFadingEnabled) {
+      return super.getLeftFadingEdgeStrength();
+    } else {
+      return 0f;
+    }
+  }
+
+  @Override
+  public float getRightFadingEdgeStrength() {
+    if (mRightFadingEnabled) {
+      return super.getRightFadingEdgeStrength();
+    } else {
+      return 0f;
+    }
+  }
+
+  @Override
+  public float getTopFadingEdgeStrength() {
+    if (mTopFadingEnabled) {
+      return super.getTopFadingEdgeStrength();
+    } else {
+      return 0f;
+    }
+  }
+
+  @Override
+  public float getBottomFadingEdgeStrength() {
+    if (mBottomFadingEnabled) {
+      return super.getBottomFadingEdgeStrength();
+    } else {
+      return 0f;
+    }
+  }
+
   /** Allows to override {@link #onInterceptTouchEvent(MotionEvent)} behavior */
   public interface TouchInterceptor {
 
diff --git a/litho-widget/src/main/java/com/facebook/litho/widget/Recycler.kt b/litho-widget/src/main/java/com/facebook/litho/widget/Recycler.kt
@@ -69,6 +69,10 @@ constructor(
     private val itemDecorations: List<RecyclerView.ItemDecoration>? = null,
     private val isHorizontalFadingEdgeEnabled: Boolean = false,
     private val isVerticalFadingEdgeEnabled: Boolean = false,
+    private val isLeftFadingEnabled: Boolean = true,
+    private val isRightFadingEnabled: Boolean = true,
+    private val isTopFadingEnabled: Boolean = true,
+    private val isBottomFadingEnabled: Boolean = true,
     private val fadingEdgeLength: Int = 0,
     private val edgeFactory: RecyclerView.EdgeEffectFactory? = null,
     @IdRes private val recyclerViewId: Int = View.NO_ID,
@@ -196,6 +200,10 @@ constructor(
                 scrollBarStyle = scrollBarStyle,
                 isHorizontalFadingEdgeEnabled = isHorizontalFadingEdgeEnabled,
                 isVerticalFadingEdgeEnabled = isVerticalFadingEdgeEnabled,
+                isLeftFadingEnabled = isLeftFadingEnabled,
+                isRightFadingEnabled = isRightFadingEnabled,
+                isTopFadingEnabled = isTopFadingEnabled,
+                isBottomFadingEnabled = isBottomFadingEnabled,
                 fadingEdgeLength = fadingEdgeLength,
                 recyclerViewId = recyclerViewId,
                 overScrollMode = overScrollMode,
@@ -326,6 +334,10 @@ constructor(
                     scrollBarStyle = scrollBarStyle,
                     isHorizontalFadingEdgeEnabled = isHorizontalFadingEdgeEnabled,
                     isVerticalFadingEdgeEnabled = isVerticalFadingEdgeEnabled,
+                    isLeftFadingEnabled = isLeftFadingEnabled,
+                    isRightFadingEnabled = isRightFadingEnabled,
+                    isTopFadingEnabled = isTopFadingEnabled,
+                    isBottomFadingEnabled = isBottomFadingEnabled,
                     fadingEdgeLength = fadingEdgeLength,
                     recyclerViewId = recyclerViewId,
                     overScrollMode = overScrollMode,
@@ -447,6 +459,10 @@ constructor(
                     scrollBarStyle = scrollBarStyle,
                     isHorizontalFadingEdgeEnabled = isHorizontalFadingEdgeEnabled,
                     isVerticalFadingEdgeEnabled = isVerticalFadingEdgeEnabled,
+                    isLeftFadingEnabled = isLeftFadingEnabled,
+                    isRightFadingEnabled = isRightFadingEnabled,
+                    isTopFadingEnabled = isTopFadingEnabled,
+                    isBottomFadingEnabled = isBottomFadingEnabled,
                     fadingEdgeLength = fadingEdgeLength,
                     recyclerViewId = recyclerViewId,
                     overScrollMode = overScrollMode,
@@ -554,6 +570,10 @@ private fun ResourcesScope.bindLegacyMountBinder(
     scrollBarStyle: Int,
     isHorizontalFadingEdgeEnabled: Boolean,
     isVerticalFadingEdgeEnabled: Boolean,
+    isLeftFadingEnabled: Boolean,
+    isRightFadingEnabled: Boolean,
+    isTopFadingEnabled: Boolean,
+    isBottomFadingEnabled: Boolean,
     fadingEdgeLength: Int,
     @IdRes recyclerViewId: Int,
     overScrollMode: Int,
@@ -579,6 +599,10 @@ private fun ResourcesScope.bindLegacyMountBinder(
   recyclerView.scrollBarStyle = scrollBarStyle
   recyclerView.isHorizontalFadingEdgeEnabled = isHorizontalFadingEdgeEnabled
   recyclerView.isVerticalFadingEdgeEnabled = isVerticalFadingEdgeEnabled
+  recyclerView.setLeftFadingEnabled(isLeftFadingEnabled)
+  recyclerView.setRightFadingEnabled(isRightFadingEnabled)
+  recyclerView.setTopFadingEnabled(isTopFadingEnabled)
+  recyclerView.setBottomFadingEnabled(isBottomFadingEnabled)
   recyclerView.setFadingEdgeLength(fadingEdgeLength.dp.toPixels())
   recyclerView.id = recyclerViewId
   recyclerView.overScrollMode = overScrollMode
