PagerSnapHelper

Kotlin |Java

open class PagerSnapHelper : SnapHelper

kotlin.Any
↳	androidx.recyclerview.widget.RecyclerView.OnFlingListener
	↳	androidx.recyclerview.widget.SnapHelper
		↳	androidx.recyclerview.widget.PagerSnapHelper

Implementation of the SnapHelper supporting pager style snapping in either vertical or horizontal orientation.

PagerSnapHelper can help achieve a similar behavior to androidx.viewpager.widget.ViewPager. Set both RecyclerView and the items of the RecyclerView.Adapter to have android.view.ViewGroup.LayoutParams#MATCH_PARENT height and width and then attach PagerSnapHelper to the RecyclerView using attachToRecyclerView(RecyclerView).

Summary

Public constructors
`<init>()` Implementation of the `SnapHelper` supporting pager style snapping in either vertical or horizontal orientation.

Public methods
open IntArray?	`calculateDistanceToFinalSnap(@NonNull layoutManager: RecyclerView.LayoutManager, @NonNull targetView: View)`
open View?	`findSnapView(layoutManager: RecyclerView.LayoutManager!)`
open Int	`findTargetSnapPosition(layoutManager: RecyclerView.LayoutManager!, velocityX: Int, velocityY: Int)`

Protected methods
open RecyclerView.SmoothScroller?	`createScroller(@NonNull layoutManager: RecyclerView.LayoutManager)`

Inherited functions

From class SnapHelper

`Unit`	`attachToRecyclerView(@Nullable recyclerView: RecyclerView?)` Attaches the `SnapHelper` to the provided RecyclerView, by calling `RecyclerView#setOnFlingListener(RecyclerView.OnFlingListener)`. You can call this method with `null` to detach it from the current RecyclerView.
`IntArray!`	`calculateScrollDistance(velocityX: Int, velocityY: Int)` Calculated the estimated scroll distance in each direction given velocities on both axes.
`LinearSmoothScroller?`	`createSnapScroller(@NonNull layoutManager: RecyclerView.LayoutManager)` Creates a scroller to be used in the snapping implementation.
`Boolean`	`onFling(velocityX: Int, velocityY: Int)`

PagerSnapHelper()

Implementation of the SnapHelper supporting pager style snapping in either vertical or horizontal orientation.

@Nullable open fun calculateDistanceToFinalSnap(
    @NonNull layoutManager: RecyclerView.LayoutManager, 
    @NonNull targetView: View
): IntArray?

@Nullable open fun findSnapView(layoutManager: RecyclerView.LayoutManager!): View?

open fun findTargetSnapPosition(
    layoutManager: RecyclerView.LayoutManager!, 
    velocityX: Int, 
    velocityY: Int
): Int

@Nullable protected open fun createScroller(@NonNull layoutManager: RecyclerView.LayoutManager): RecyclerView.SmoothScroller?