backpack-compose/net.skyscanner.backpack.compose.carousel/BpkCarouselState

BpkCarouselState

sealed interface BpkCarouselState : ScrollableState

Properties

canScrollBackward

open val canScrollBackward: Boolean

canScrollForward

open val canScrollForward: Boolean

@get:IntRange(from = 0)

abstract val currentPage: Int

currentPageOffsetFraction

abstract val currentPageOffsetFraction: Float

interactionSource

abstract val interactionSource: InteractionSource

isScrollInProgress

abstract val isScrollInProgress: Boolean

lastScrolledBackward

open val lastScrolledBackward: Boolean

lastScrolledForward

open val lastScrolledForward: Boolean

@get:IntRange(from = 0)

abstract val pageCount: Int

Functions

animateScrollToPage

abstract suspend fun animateScrollToPage(@IntRange(from = 0) page: Int, @FloatRange(from = -1.0, to = 1.0) pageOffset: Float = 0.0f)

dispatchRawDelta

abstract fun dispatchRawDelta(delta: Float): Float

abstract suspend fun scroll(scrollPriority: MutatePriority, block: suspend ScrollScope.() -> Unit)

abstract suspend fun scrollToPage(@IntRange(from = 0) page: Int, @FloatRange(from = -1.0, to = 1.0) pageOffset: Float = 0.0f)