Package com.google.accompanist.pager

Types

ExperimentalPagerApi
Link copied to clipboard
annotation class ExperimentalPagerApi
Content copied to clipboard
PagerDefaults
Link copied to clipboard
object PagerDefaults
Content copied to clipboard
Contains the default values used by HorizontalPager and VerticalPager.
PagerScope
Link copied to clipboard
@Stable()
interface PagerScope
Content copied to clipboard
Scope for HorizontalPager content.
PagerState
Link copied to clipboard
@Stable()
class PagerState(@IntRange(from = 0.toLong()) currentPage: Int) : ScrollableState
Content copied to clipboard
A state object that can be hoisted to control and observe scrolling for HorizontalPager.

Functions

calculateCurrentOffsetForPage
Link copied to clipboard
fun PagerScope.calculateCurrentOffsetForPage(page: Int): Float
Content copied to clipboard
Calculate the offset for the given page from the current scroll position.
HorizontalPager
Link copied to clipboard
@Composable()
fun HorizontalPager(count: Int, modifier: Modifier = Modifier, state: PagerState = rememberPagerState(), reverseLayout: Boolean = false, itemSpacing: Dp = 0.dp, contentPadding: PaddingValues = PaddingValues(0.dp), verticalAlignment: Alignment.Vertical = Alignment.CenterVertically, flingBehavior: FlingBehavior = PagerDefaults.flingBehavior( state = state, endContentPadding = contentPadding.calculateEndPadding(LayoutDirection.Ltr), ), key: (page: Int) -> Any? = null, userScrollEnabled: Boolean = true, content: @Composable() PagerScope.(page: Int) -> Unit)
Content copied to clipboard
A horizontally scrolling layout that allows users to flip between items to the left and right.
rememberPagerState
Link copied to clipboard
@Composable()
fun rememberPagerState(@IntRange(from = 0.toLong()) initialPage: Int = 0): PagerState
Content copied to clipboard
Creates a PagerState that is remembered across compositions.
VerticalPager
Link copied to clipboard
@Composable()
fun VerticalPager(count: Int, modifier: Modifier = Modifier, state: PagerState = rememberPagerState(), reverseLayout: Boolean = false, itemSpacing: Dp = 0.dp, contentPadding: PaddingValues = PaddingValues(0.dp), horizontalAlignment: Alignment.Horizontal = Alignment.CenterHorizontally, flingBehavior: FlingBehavior = PagerDefaults.flingBehavior( state = state, endContentPadding = contentPadding.calculateBottomPadding(), ), key: (page: Int) -> Any? = null, userScrollEnabled: Boolean = true, content: @Composable() PagerScope.(page: Int) -> Unit)
Content copied to clipboard
A vertically scrolling layout that allows users to flip between items to the top and bottom.