recyclerview/dev.funkymuse.recyclerview

Package-level declarations

Types

abstract class AbstractViewBindingAdapter<T, VH : RecyclerView.ViewHolder, VB : ViewBinding>(viewHolder: (binding: VB) -> VH, bindingInflater: (LayoutInflater, ViewGroup, Boolean) -> VB, areItemsTheSameCallback: (old: T, new: T) -> Boolean? = { _, _ -> null }, areContentsTheSameCallback: (old: T, new: T) -> Boolean? = { _, _ -> null }, onCreateBinding: (holder: VH) -> Unit = {}) : ListAdapter<T, VH>

Takes leverage of not providing that damn layout res id

AbstractViewBindingAdapterSingleSelection

abstract class AbstractViewBindingAdapterSingleSelection<T, VH : RecyclerView.ViewHolder, VB : ViewBinding>(viewHolder: (binding: VB) -> VH, bindingInflater: (LayoutInflater, ViewGroup, Boolean) -> VB, areItemsTheSameCallback: (old: T, new: T) -> Boolean? = { _, _ -> null }, areContentsTheSameCallback: (old: T, new: T) -> Boolean? = { _, _ -> null }, onCreateBinding: (holder: VH) -> Unit = {}) : ListAdapter<T, VH>

Takes leverage of not providing that damn layout res id

AbstractViewBindingCleanAdapter

abstract class AbstractViewBindingCleanAdapter<T, VB : ViewBinding>(bindingInflater: (LayoutInflater, ViewGroup, Boolean) -> VB, areItemsTheSameCallback: (old: T, new: T) -> Boolean? = { _, _ -> null }, areContentsTheSameCallback: (old: T, new: T) -> Boolean? = { _, _ -> null }) : ListAdapter<T, AbstractViewBindingCleanAdapter.AbstractViewHolder<VB>>

Takes leverage of not providing that damn layout res id

AbstractViewBindingHolderAdapter

abstract class AbstractViewBindingHolderAdapter<T, VB : ViewBinding>(bindingInflater: (LayoutInflater, ViewGroup, Boolean) -> VB, areItemsTheSameCallback: (old: T, new: T) -> Boolean? = { _, _ -> null }, areContentsTheSameCallback: (old: T, new: T) -> Boolean? = { _, _ -> null }, onCreateBinding: (holder: AbstractViewBindingHolderAdapter.AbstractViewHolder<VB>) -> Unit = {}) : ListAdapter<T, AbstractViewBindingHolderAdapter.AbstractViewHolder<VB>>

Takes leverage of not providing that damn layout res id

AdvancedDividerItemDecoration

class AdvancedDividerItemDecoration : RecyclerView.ItemDecoration

AutoFitGridLayoutManager

class AutoFitGridLayoutManager(context: Context, columnWidth: Int) : GridLayoutManager

layout width must be match parent

GenericDiffUtil

class GenericDiffUtil<T>(areItemsTheSameCallback: (old: T, new: T) -> Boolean?, areContentsTheSameCallback: (old: T, new: T) -> Boolean?) : DiffUtil.ItemCallback<T>

Use T as data class preferably if you don't pass anything in constructors

HideOnScrollListener

abstract class HideOnScrollListener(HIDE_THRESHOLD: Int = 20) : RecyclerView.OnScrollListener

ItemOffsetDecoration

class ItemOffsetDecoration(itemOffset: Int) : RecyclerView.ItemDecoration

MenuClicker

interface MenuClicker

OnStartActionMode

interface OnStartActionMode

OrientationAwareRecyclerView

class OrientationAwareRecyclerView(context: Context, attrs: AttributeSet?, defStyleAttr: Int) : RecyclerView

PlaceholderAdapter

abstract class PlaceholderAdapter<VH : RecyclerView.ViewHolder> : RecyclerView.Adapter<VH>

RecyclerHorizontalItemHeaderDecoration

class RecyclerHorizontalItemHeaderDecoration(sectionCallback: RecyclerHorizontalItemHeaderDecoration.SectionCallback, headerViewID: Int, sectionHeaderLayoutName: Int) : RecyclerView.ItemDecoration

/* USAGE val sectionItemDecoration = RecyclerSectionItemDecoration(R.id.list_item_section_text, R.layout.section_header object : RecyclerSectionItemDecoration.SectionCallback {

RecyclerSectionItemDecoration

class RecyclerSectionItemDecoration(headerOffset: Int, sticky: Boolean, sectionCallback: RecyclerSectionItemDecoration.SectionCallback, headerViewID: Int, sectionHeaderLayoutName: Int) : RecyclerView.ItemDecoration

/* USAGE val sectionItemDecoration = RecyclerSectionItemDecoration(resources.getDimensionPixelSize(R.dimen.recycler_section_header_height), false, // true for sticky, false for not, R.id.list_item_section_text, R.layout.section_header object : RecyclerSectionItemDecoration.SectionCallback {

RecyclerSwipeItemHandler

data class RecyclerSwipeItemHandler(var drawableLeft: Int? = null, var drawLeftBackground: Boolean = false, var leftBackgroundColor: Int? = null, var drawableRight: Int? = null, var drawRightBackground: Boolean = false, var rightBackgroundColor: Int? = null, var swipeDirection: RecyclerSwipeItemHandler.SwipeDirs = SwipeDirs.BOTH)

RecyclerViewUtils

class RecyclerViewUtils

RecyclerViewUtilsActionMode

class RecyclerViewUtilsActionMode

ScrollStateHolder

class ScrollStateHolder(savedInstanceState: Bundle? = null)

Persists scroll state for nested RecyclerViews.

SpaceDecoration

class SpaceDecoration(start: Int = 0, top: Int = 0, end: Int = 0, bottom: Int = 0) : RecyclerView.ItemDecoration

ItemDecoration that adds space around items.

Properties

context

val RecyclerView.ViewHolder.context: Context

isEmpty

val <VH : RecyclerView.ViewHolder> RecyclerView.Adapter<VH>.isEmpty: Boolean

isNotEmpty

val <VH : RecyclerView.ViewHolder> RecyclerView.Adapter<VH>.isNotEmpty: Boolean

orientation

val RecyclerView.orientation: Int

resources

val RecyclerView.ViewHolder.resources: Resources

Functions

addDrag

fun <T> RecyclerView.addDrag(adapter: RecyclerView.Adapter<*>, adapterList: MutableList<T>)

Extension function for recyclerDrag

addHorizontalDivider

fun RecyclerView.addHorizontalDivider(context: Context, layoutManager: LinearLayoutManager)

addSwipe

fun RecyclerView?.addSwipe(context: Context, leftAction: (swipedPosition: Int) -> Unit = { _ -> }, rightAction: (swipedPosition: Int) -> Unit = { _ -> }, recyclerSwipeItemHandler: RecyclerSwipeItemHandler.() -> Unit)

Extension function for recyclerSwipe

calculateNoOfColumns

fun Context.calculateNoOfColumns(columnWidthDp: Float): Int

clearDecorations

fun RecyclerView.clearDecorations()

clearOnDetach

fun RecyclerView.clearOnDetach()

diffUtilDSL

fun <T> diffUtilDSL(areItemsTheSameCallback: (old: T, new: T) -> Boolean? = { _, _ -> null }, areContentsTheSameCallback: (old: T, new: T) -> Boolean? = { _, _ -> null }): GenericDiffUtil<old: T>

disableAnimations

fun RecyclerView.disableAnimations()

disableTouch

fun RecyclerView.disableTouch()

Disable all user input to a recyclerview, passing touch events out

divider

fun RecyclerView.divider(color: Int = Color.parseColor("#CCCCCC"), size: Int = 1): RecyclerView

enableAnimations

fun RecyclerView.enableAnimations(addDuration: Long = 120, removeDuration: Long = 120, moveDuration: Long = 250, changeDuration: Long = 250)

fullLinearRecycler

fun Context.fullLinearRecycler(rvAdapter: RecyclerView.Adapter<*>? = null, configs: RecyclerView.() -> Unit = {}): RecyclerView

Generates a recycler view with match parent and a linearlayoutmanager, since it's so commonly used

fullScreenGestureNavigation

fun RecyclerView.fullScreenGestureNavigation(fragment: Fragment)

fun RecyclerView.fullScreenGestureNavigation(fragmentActivity: FragmentActivity, topInset: Int = 200, bottomInset: Int = 40)

generateHorizontalAdapter

inline fun <T, VH : RecyclerView.ViewHolder, VB : ViewBinding> RecyclerView.generateHorizontalAdapter(noinline viewHolder: (binding: VB) -> VH, noinline bindingInflater: (LayoutInflater, ViewGroup, Boolean) -> VB, noinline areItemsTheSameCallback: (old: T, new: T) -> Boolean? = { _, _ -> null }, noinline areContentsTheSameCallback: (old: T, new: T) -> Boolean? = { _, _ -> null }, crossinline binder: (item: T, holder: VH, position: Int, itemCount: Int) -> Unit, hasFixedSize: Boolean = false, reverseLayout: Boolean = false): AbstractViewBindingAdapter<T, VH, VB>

generateHorizontalAdapterWithHolder

inline fun <T, VB : ViewBinding> RecyclerView.generateHorizontalAdapterWithHolder(noinline bindingInflater: (LayoutInflater, ViewGroup, Boolean) -> VB, noinline areItemsTheSameCallback: (old: T, new: T) -> Boolean? = { _, _ -> null }, noinline areContentsTheSameCallback: (old: T, new: T) -> Boolean? = { _, _ -> null }, noinline onCreateBinding: (holder: AbstractViewBindingHolderAdapter.AbstractViewHolder<VB>) -> Unit = {}, crossinline binder: (item: T, position: Int, itemCount: Int, binding: VB, context: Context) -> Unit, hasFixedSize: Boolean = false, reverseLayout: Boolean = false): AbstractViewBindingHolderAdapter<T, VB>

generateRecycler

inline fun <T, VH : RecyclerView.ViewHolder, VB : ViewBinding> generateRecycler(noinline viewHolder: (binding: VB) -> VH, noinline bindingInflater: (LayoutInflater, ViewGroup, Boolean) -> VB, noinline areItemsTheSameCallback: (old: T, new: T) -> Boolean? = { _, _ -> null }, noinline areContentsTheSameCallback: (old: T, new: T) -> Boolean? = { _, _ -> null }, crossinline binder: (item: T, holder: VH, position: Int, itemCount: Int) -> Unit): AbstractViewBindingAdapter<T, VH, VB>

generateRecyclerWithHolder

inline fun <T, VB : ViewBinding> generateRecyclerWithHolder(noinline bindingInflater: (LayoutInflater, ViewGroup, Boolean) -> VB, noinline areItemsTheSameCallback: (old: T, new: T) -> Boolean? = { _, _ -> null }, noinline areContentsTheSameCallback: (old: T, new: T) -> Boolean? = { _, _ -> null }, noinline onCreateBinding: (holder: AbstractViewBindingHolderAdapter.AbstractViewHolder<VB>) -> Unit = {}, crossinline binder: (item: T, position: Int, itemCount: Int, binding: VB, context: Context) -> Unit): AbstractViewBindingHolderAdapter<T, VB>

generateVerticalAdapter

inline fun <T, VH : RecyclerView.ViewHolder, VB : ViewBinding> RecyclerView.generateVerticalAdapter(noinline viewHolder: (binding: VB) -> VH, noinline bindingInflater: (LayoutInflater, ViewGroup, Boolean) -> VB, noinline areItemsTheSameCallback: (old: T, new: T) -> Boolean? = { _, _ -> null }, noinline areContentsTheSameCallback: (old: T, new: T) -> Boolean? = { _, _ -> null }, crossinline binder: (item: T, holder: VH, position: Int, itemCount: Int) -> Unit, hasFixedSize: Boolean = false, reverseLayout: Boolean = false): AbstractViewBindingAdapter<T, VH, VB>

generateVerticalAdapterWithHolder

inline fun <T, VB : ViewBinding> RecyclerView.generateVerticalAdapterWithHolder(noinline bindingInflater: (LayoutInflater, ViewGroup, Boolean) -> VB, noinline areItemsTheSameCallback: (old: T, new: T) -> Boolean? = { _, _ -> null }, noinline areContentsTheSameCallback: (old: T, new: T) -> Boolean? = { _, _ -> null }, noinline onCreateBinding: (holder: AbstractViewBindingHolderAdapter.AbstractViewHolder<VB>) -> Unit = {}, crossinline binder: (item: T, position: Int, itemCount: Int, binding: VB, context: Context) -> Unit, hasFixedSize: Boolean = false, reverseLayout: Boolean = false): AbstractViewBindingHolderAdapter<T, VB>

getColor

fun RecyclerView.ViewHolder.getColor(resId: Int): Int

getDrawable

fun RecyclerView.ViewHolder.getDrawable(resId: Int): Drawable?

getFirstVisibleItemPosition

fun RecyclerView.getFirstVisibleItemPosition(): Int?

getLastVisibleItemPosition

fun RecyclerView.getLastVisibleItemPosition(): Int?

getSnapPosition

fun RecyclerView.getSnapPosition(snapHelper: SnapHelper): Int

fun SnapHelper.getSnapPosition(recyclerView: RecyclerView): Int

getString

fun RecyclerView.ViewHolder.getString(resId: Int): String

fun RecyclerView.ViewHolder.getString(resId: Int, format: Any): String

handleInsideBottomSheet

fun RecyclerView?.handleInsideBottomSheet()

To prevent the RecyclerView stealing touches from the bottom sheet fragment or any other fragment that scrolls, use this function If you're using other recycler views besides this one, use OrientationAwareRecyclerView for them

hideOnScroll

inline fun RecyclerView.hideOnScroll(threshold: Int = 20, crossinline hide: () -> Unit = {}, crossinline show: () -> Unit = {})

horizontal

fun RecyclerView.horizontal(spanCount: Int = 0, isStaggered: Boolean = false): RecyclerView

horizontalDivider

fun RecyclerView.horizontalDivider(drawable: Drawable, dividerSize: Int = drawable.intrinsicHeight.coerceAtLeast(1), padding: Int = 0)

Adds an RecyclerView.ItemDecoration that draws a horizontal divider between items.

initRecyclerViewAdapter

fun <T : RecyclerView.Adapter<*>> RecyclerView.initRecyclerViewAdapter(yourAdapter: T, yourLayoutManager: RecyclerView.LayoutManager, fixedSize: Boolean = false)

fun <T : RecyclerView.Adapter<*>> RecyclerView.initRecyclerViewAdapter(yourAdapter: T, layoutOrientation: Int = RecyclerView.VERTICAL, fixedSize: Boolean = false, reverseLayout: Boolean = false)

Set adapter of recyclerView

isFirstChild

fun RecyclerView.isFirstChild(view: View): Boolean

isLastChild

fun RecyclerView.isLastChild(view: View): Boolean

isReverseLayout

fun RecyclerView.isReverseLayout(): Boolean

fun RecyclerView.LayoutManager.isReverseLayout(): Boolean

onChanged

fun RecyclerView.Adapter<*>.onChanged(action: () -> Unit = { }): RecyclerView.AdapterDataObserver

onItemRangeChanged

fun RecyclerView.Adapter<*>.onItemRangeChanged(action: (positionStart: Int, itemCount: Int) -> Unit = { _, _ -> }): RecyclerView.AdapterDataObserver

fun RecyclerView.Adapter<*>.onItemRangeChanged(action: (positionStart: Int, itemCount: Int, payload: Any?) -> Unit = { _, _, _ -> }): RecyclerView.AdapterDataObserver

onItemRangeInserted

fun RecyclerView.Adapter<*>.onItemRangeInserted(action: (positionStart: Int, itemCount: Int) -> Unit = { _, _ -> }): RecyclerView.AdapterDataObserver

onItemRangeMoved

fun RecyclerView.Adapter<*>.onItemRangeMoved(action: (fromPosition: Int, toPosition: Int, itemCount: Int) -> Unit = { _, _, _ -> }): RecyclerView.AdapterDataObserver

onItemRangeRemoved

fun RecyclerView.Adapter<*>.onItemRangeRemoved(action: (positionStart: Int, itemCount: Int) -> Unit = { _, _ -> }): RecyclerView.AdapterDataObserver

recyclerChangeItemAtPosition

fun <T> recyclerChangeItemAtPosition(adapterList: MutableList<T>, adapter: RecyclerView.Adapter<*>, positionForChanging: Int, itemToChange: T)

recyclerDeleteItem

fun <T> recyclerDeleteItem(adapterList: MutableList<T>, adapter: RecyclerView.Adapter<*>, positionForDeletion: Int)

recyclerDeleteItems

fun <T> recyclerDeleteItems(list: MutableList<T>, adapter: RecyclerView.Adapter<*>, position: Int)

recyclerDeleteItemWithUndo

fun <T> recyclerDeleteItemWithUndo(adapterList: MutableList<T>, adapter: RecyclerView.Adapter<*>, positionForDeletion: Int, rootLayout: View)

recyclerDrag

fun <T> recyclerDrag(adapter: RecyclerView.Adapter<*>, adapterList: MutableList<T>): ItemTouchHelper

Don't forget to call ItemTouchHelper.attachToRecyclerView on this since it returns ItemTouchHelper or use addDrag as an extension function

recyclerInsertItemOnLastPosition

fun <T> recyclerInsertItemOnLastPosition(adapterList: MutableList<T>, adapter: RecyclerView.Adapter<*>, itemToInsert: T)

recyclerInsertMultipleItems

fun <T> recyclerInsertMultipleItems(adapterList: MutableList<T>, adapter: RecyclerView.Adapter<*>, insertionStartsAt: Int, listToInsert: MutableList<T>)

recyclerSwipe

fun recyclerSwipe(context: Context, leftAction: (swipedPosition: Int) -> Unit = { _ -> }, rightAction: (swipedPosition: Int) -> Unit = { _ -> }, recyclerSwipeItemHandler: RecyclerSwipeItemHandler.() -> Unit): ItemTouchHelper

Don't forget to call ItemTouchHelper.attachToRecyclerView on this since it returns ItemTouchHelper or use addSwipe

registerDataObserver

fun RecyclerView.Adapter<*>.registerDataObserver(action: () -> Unit = {}): RecyclerView.AdapterDataObserver

replaceAdapterWith

fun RecyclerView.replaceAdapterWith(replacementAdapter: RecyclerView.Adapter<*>, transition: Transition? = null, onAnimator: (RecyclerView.ItemAnimator?) -> Unit)

scrollListener

fun RecyclerView.scrollListener(onScrollStateChanged: (recycler: RecyclerView, newState: Int) -> Unit = { _, _ -> }, onScrolled: (recycler: RecyclerView, scrollbyX: Int, scrollbyY: Int) -> Unit = { _, _, _ -> })

setAppBarElevationListener

fun RecyclerView.setAppBarElevationListener(appBar: AppBarLayout, elevation: Float = 8.0f)

setSpanSize

fun GridLayoutManager.setSpanSize(func: (Int) -> Int)

shimmerAnimation

fun RecyclerView.ViewHolder.shimmerAnimation(FADE_DURATION: Long = 1000): ObjectAnimator

Usage

smoothScrollTo

fun RecyclerView.smoothScrollTo(position: Int, callback: () -> Unit? = null)

smoothSnapToPosition

fun RecyclerView.smoothSnapToPosition(position: Int, performClick: Boolean = true)

vertical

fun RecyclerView.vertical(spanCount: Int = 0, isStaggered: Boolean = false): RecyclerView

verticalDivider

fun RecyclerView.verticalDivider(drawable: Drawable, dividerSize: Int = drawable.intrinsicHeight.coerceAtLeast(1), padding: Int = 0)

Adds an RecyclerView.ItemDecoration that draws a vertical divider between items.

withGridLayoutManager

fun RecyclerView.withGridLayoutManager(spanCount: Int): RecyclerView

Set a GridLayoutManager as this layoutManager.

withItemOffsetDecoration

fun RecyclerView.withItemOffsetDecoration(@DimenRes dimenRes: Int): RecyclerView

Calls RecyclerView.addItemDecoration with ItemOffsetDecoration as a parameter.

withLinearAdapter

fun RecyclerView.withLinearAdapter(rvAdapter: RecyclerView.Adapter<*>): RecyclerView

Sets a linear layout manager along with an adapter

withLinearLayoutManager

fun RecyclerView.withLinearLayoutManager(vertical: Boolean = true, reversed: Boolean = false): RecyclerView

Set a LinearLayoutManager as this layoutManager.

withPagerSnapHelper

fun RecyclerView.withPagerSnapHelper(): RecyclerView