Carousel

open class Carousel : EpoxyRecyclerView

This feature is in Beta - please report bugs, feature requests, or other feedback at https://github.com/airbnb/epoxy by creating a new issue. Thanks!

This is intended as a plug and play "Carousel" view - a Recyclerview with horizontal scrolling. It comes with common defaults and performance optimizations and can be either used as a top level RecyclerView, or nested within a vertical recyclerview.

This class provides:

1. Automatic integration with Epoxy. A CarouselModel_ is generated from this class, which you can use in your EpoxyController. Just call setModels to provide the list of models to show in the carousel.

2. Default padding for carousel peeking, and an easy way to change this padding -

3. Easily control how many items are shown on screen in the carousel at a time -

4. Easy snap support. By default a LinearSnapHelper is used, but you can set a global default for all Carousels with setDefaultGlobalSnapHelperFactory

5. All of the benefits of EpoxyRecyclerView

If you need further flexibility you can subclass this view to change its width, height, scrolling direction, etc. You can annotate a subclass with ModelView to generate a new EpoxyModel.

Constructors

Carousel

open fun Carousel(context: Context)

Carousel

open fun Carousel(context: Context, @Nullable() attrs: AttributeSet)

Carousel

open fun Carousel(context: Context, @Nullable() attrs: AttributeSet, defStyle: Int)

Types

Padding

open class Padding

Used to specify individual padding values programmatically.

SnapHelperFactory

abstract class SnapHelperFactory

Provide a SnapHelper implementation you want to use with a Carousel.

Functions

addChildrenForAccessibility

open fun addChildrenForAccessibility(outChildren: ArrayList<View>)

addExtraDataToAccessibilityNodeInfo

open fun addExtraDataToAccessibilityNodeInfo(info: AccessibilityNodeInfo, extraDataKey: String, arguments: Bundle)

addFocusables

open fun addFocusables(views: ArrayList<View>, direction: Int, focusableMode: Int)

addItemDecoration

open fun addItemDecoration(decor: RecyclerView.ItemDecoration, index: Int)

addKeyboardNavigationClusters

open fun addKeyboardNavigationClusters(views: Collection<View>, direction: Int)

addOnAttachStateChangeListener

open fun addOnAttachStateChangeListener(listener: View.OnAttachStateChangeListener)

addOnChildAttachStateChangeListener

open fun addOnChildAttachStateChangeListener(listener: RecyclerView.OnChildAttachStateChangeListener)

addOnItemTouchListener

open fun addOnItemTouchListener(listener: RecyclerView.OnItemTouchListener)

addOnLayoutChangeListener

open fun addOnLayoutChangeListener(listener: View.OnLayoutChangeListener)

addOnScrollListener

open fun addOnScrollListener(listener: RecyclerView.OnScrollListener)

addOnUnhandledKeyEventListener

open fun addOnUnhandledKeyEventListener(listener: View.OnUnhandledKeyEventListener)

addPreloader

fun <T : EpoxyModel<out Any>?, U : ViewMetadata?, P : PreloadRequestHolder?> addPreloader(maxPreloadDistance: Int, errorHandler: (out Any, out Any) -> Unit, preloader: EpoxyModelPreloader<T, U, P>, requestHolderFactory: () -> out P)

addStatesFromChildren

open fun addStatesFromChildren(): Boolean

addTouchables

open fun addTouchables(views: ArrayList<View>)

addView

open fun addView(child: View)

animate

open fun animate(): ViewPropertyAnimator

announceForAccessibility

open fun announceForAccessibility(text: CharSequence)

autofill

open fun autofill(value: AutofillValue)

bringChildToFront

open fun bringChildToFront(child: View)

bringToFront

open fun bringToFront()

buildDrawingCache

open fun buildDrawingCache()

buildLayer

open fun buildLayer()

buildModelsWith

fun buildModelsWith(callback: Null)

callOnClick

open fun callOnClick(): Boolean

cancelDragAndDrop

fun cancelDragAndDrop()

cancelLongPress

open fun cancelLongPress()

cancelPendingInputEvents

fun cancelPendingInputEvents()

canResolveLayoutDirection

open fun canResolveLayoutDirection(): Boolean

canResolveTextAlignment

open fun canResolveTextAlignment(): Boolean

canResolveTextDirection

open fun canResolveTextDirection(): Boolean

canScrollHorizontally

open fun canScrollHorizontally(direction: Int): Boolean

canScrollVertically

open fun canScrollVertically(direction: Int): Boolean

checkInputConnectionProxy

open fun checkInputConnectionProxy(view: View): Boolean

childDrawableStateChanged

open fun childDrawableStateChanged(child: View)

childHasTransientStateChanged

open fun childHasTransientStateChanged(child: View, childHasTransientState: Boolean)

clear

open fun clear()

clearAnimation

open fun clearAnimation()

clearChildFocus

open fun clearChildFocus(child: View)

clearDisappearingChildren

open fun clearDisappearingChildren()

clearFocus

open fun clearFocus()

clearOnChildAttachStateChangeListeners

open fun clearOnChildAttachStateChangeListeners()

clearOnScrollListeners

open fun clearOnScrollListeners()

clearPreloaders

fun clearPreloaders()

combineMeasuredStates

open fun combineMeasuredStates(curState: Int, newState: Int): Int

computeHorizontalScrollExtent

open fun computeHorizontalScrollExtent(): Int

computeHorizontalScrollOffset

open fun computeHorizontalScrollOffset(): Int

computeHorizontalScrollRange

open fun computeHorizontalScrollRange(): Int

computeScroll

open fun computeScroll()

computeSystemWindowInsets

open fun computeSystemWindowInsets(in: WindowInsets, outLocalInsets: Rect): WindowInsets

computeVerticalScrollExtent

open fun computeVerticalScrollExtent(): Int

computeVerticalScrollOffset

open fun computeVerticalScrollOffset(): Int

computeVerticalScrollRange

open fun computeVerticalScrollRange(): Int

createAccessibilityNodeInfo

open fun createAccessibilityNodeInfo(): AccessibilityNodeInfo

createContextMenu

open fun createContextMenu(menu: ContextMenu)

destroyDrawingCache

open fun destroyDrawingCache()

dispatchApplyWindowInsets

open fun dispatchApplyWindowInsets(insets: WindowInsets): WindowInsets

dispatchCapturedPointerEvent

open fun dispatchCapturedPointerEvent(event: MotionEvent): Boolean

dispatchConfigurationChanged

open fun dispatchConfigurationChanged(newConfig: Configuration)

dispatchDisplayHint

open fun dispatchDisplayHint(hint: Int)

dispatchDragEvent

open fun dispatchDragEvent(event: DragEvent): Boolean

dispatchDrawableHotspotChanged

open fun dispatchDrawableHotspotChanged(x: Float, y: Float)

dispatchFinishTemporaryDetach

open fun dispatchFinishTemporaryDetach()

dispatchGenericMotionEvent

open fun dispatchGenericMotionEvent(event: MotionEvent): Boolean

dispatchKeyEvent

open fun dispatchKeyEvent(event: KeyEvent): Boolean

dispatchKeyEventPreIme

open fun dispatchKeyEventPreIme(event: KeyEvent): Boolean

dispatchKeyShortcutEvent

open fun dispatchKeyShortcutEvent(event: KeyEvent): Boolean

dispatchNestedFling

open fun dispatchNestedFling(velocityX: Float, velocityY: Float, consumed: Boolean): Boolean

dispatchNestedPreFling

open fun dispatchNestedPreFling(velocityX: Float, velocityY: Float): Boolean

dispatchNestedPrePerformAccessibilityAction

open fun dispatchNestedPrePerformAccessibilityAction(action: Int, arguments: Bundle): Boolean

dispatchNestedPreScroll

open fun dispatchNestedPreScroll(dx: Int, dy: Int, consumed: Array<Int>, offsetInWindow: Array<Int>): Boolean

dispatchNestedScroll

open fun dispatchNestedScroll(dxConsumed: Int, dyConsumed: Int, dxUnconsumed: Int, dyUnconsumed: Int, offsetInWindow: Array<Int>): Boolean

fun dispatchNestedScroll(dxConsumed: Int, dyConsumed: Int, dxUnconsumed: Int, dyUnconsumed: Int, offsetInWindow: Array<Int>, type: Int, consumed: Array<Int>)

dispatchPointerCaptureChanged

open fun dispatchPointerCaptureChanged(hasCapture: Boolean)

dispatchPopulateAccessibilityEvent

open fun dispatchPopulateAccessibilityEvent(event: AccessibilityEvent): Boolean

dispatchProvideAutofillStructure

open fun dispatchProvideAutofillStructure(structure: ViewStructure, flags: Int)

dispatchProvideStructure

open fun dispatchProvideStructure(structure: ViewStructure)

dispatchSetActivated

open fun dispatchSetActivated(activated: Boolean)

dispatchSetSelected

open fun dispatchSetSelected(selected: Boolean)