litho-widget/com.facebook.litho.widget/RecyclerBinderConfig

RecyclerBinderConfig

data class RecyclerBinderConfig(val componentsConfiguration: ComponentsConfiguration? = null, val isCircular: Boolean = false, val lithoViewFactory: LithoViewFactory? = null, val hScrollAsyncMode: Boolean = false, val requestMountForPrefetchedItems: Boolean = false, val recyclerViewItemPrefetch: Boolean = false, val itemViewCacheSize: Int = 0, val componentWarmer: ComponentWarmer? = null, val estimatedViewportCount: Int? = null, val layoutHandlerFactory: LayoutHandlerFactory? = null, val rangeRatio: Float = DEFAULT_RANGE_RATIO, val enableStableIds: Boolean? = null, val wrapContent: Boolean = false, val crossAxisWrapMode: CrossAxisWrapMode = CrossAxisWrapMode.NoWrap, val paginationStrategy: Int = RecyclerBinder.PaginationStrategy.DEFAULT)

This configuration is meant to be used in the context of RecyclerBinder. It allows you to define to define specific behavior changes to the default behaviour of the RecyclerBinder.

At this point, we are still in a transition phase where a lot of configs still live in the RecyclerBinder.Builder, but we aim to move all of them here.

Constructors

RecyclerBinderConfig

constructor(componentsConfiguration: ComponentsConfiguration? = null, isCircular: Boolean = false, lithoViewFactory: LithoViewFactory? = null, hScrollAsyncMode: Boolean = false, requestMountForPrefetchedItems: Boolean = false, recyclerViewItemPrefetch: Boolean = false, itemViewCacheSize: Int = 0, componentWarmer: ComponentWarmer? = null, estimatedViewportCount: Int? = null, layoutHandlerFactory: LayoutHandlerFactory? = null, rangeRatio: Float = DEFAULT_RANGE_RATIO, enableStableIds: Boolean? = null, wrapContent: Boolean = false, crossAxisWrapMode: CrossAxisWrapMode = CrossAxisWrapMode.NoWrap, paginationStrategy: Int = RecyclerBinder.PaginationStrategy.DEFAULT)

Types

object Companion

Properties

componentsConfiguration

val componentsConfiguration: ComponentsConfiguration? = null

Defines if an overriding com.facebook.litho.config.ComponentsConfiguration should be used in the com.facebook.litho.ComponentTree used in the RecyclerBinder hierarchy.

componentWarmer

val componentWarmer: ComponentWarmer? = null

Set pool for pre-computing and storing ComponentTree, which can be used to pre-compute and store ComponentTrees before they are inserted in a RecyclerBinder.

crossAxisWrapMode

val crossAxisWrapMode: CrossAxisWrapMode

Specifies how a Collection will wrap its contents across the cross axis.

enableStableIds

val enableStableIds: Boolean? = null

If set, the RecyclerView adapter will have stableId support turned on. Please note that this configuration will be disregarded in case isCircular is set to true. If not set, it will follow the default value set for the ComponentsConfiguration

estimatedViewportCount

val estimatedViewportCount: Int? = null

This is used in very specific cases on critical performance paths where measuring the first item cannot be relied on to estimate the viewport count. It should not be used in the common case, use with caution.

hScrollAsyncMode

val hScrollAsyncMode: Boolean = false

Experimental. Configuration to change the behavior of HScroll's when they are nested within a vertical scroll. With this mode, the hscroll will attempt to compute all layouts in the background before mounting so that no layouts are computed on the main thread. All subsequent insertions will be treated with LAYOUT_BEFORE_INSERT policy to ensure those layouts also do not happen on the main thread.

val isCircular: Boolean = false

Whether the underlying RecyclerBinder will have a circular behaviour. Defaults to false.

itemViewCacheSize

val itemViewCacheSize: Int = 0

Set the number of offscreen views to retain before adding them to the potentially shared recycled view pool.

layoutHandlerFactory

val layoutHandlerFactory: LayoutHandlerFactory? = null

The RecyclerBinder will use this LayoutHandlerFactory when creating com.facebook.litho.ComponentTree in order to specify on which thread layout calculation should happen. Setting it to null means that the computation will be done in the background thread.

lithoViewFactory

val lithoViewFactory: LithoViewFactory? = null

The factory that will be used to create the nested com.facebook.litho.LithoView inside Section/LazyCollection.

paginationStrategy

val paginationStrategy: Int

The strategy to make Recycler stick to the last unseen item while pagination, which is only supposed to be used in full screen size surfaces like Reels.

val rangeRatio: Float

Ratio to determine the number of components before and after the androidx.recyclerview.widget.RecyclerView's total number of currently visible items to have their com.facebook.litho.Component layout computed ahead of time.

recyclerViewItemPrefetch

val recyclerViewItemPrefetch: Boolean = false

Set whether item prefetch should be enabled on the underlying RecyclerView.LayoutManager. Defaults to false.

requestMountForPrefetchedItems

val requestMountForPrefetchedItems: Boolean = false

Enable pre-mounting for pre-fetched items, which requires to turn on RecyclerView's item prefetching first.

val wrapContent: Boolean = false

If true, the RecyclerBinder will measure the parent height by the height of children if the orientation is vertical, or measure the parent width by the width of children if the orientation is horizontal.