Compose 中的分页器

如需左右翻阅内容，或者上下翻阅内容，您可以分别使用 HorizontalPager 和 VerticalPager 可组合项。这些可组合项与视图系统中的 ViewPager 具有类似的函数。默认情况下，HorizontalPager 占据屏幕的整个宽度，VerticalPager 占据整个高度，并且分页器一次仅滑动一个页面。这些默认值都可以配置。

注意 ：Compose Pager 处于实验阶段。如有任何问题，请在问题跟踪器上提交。

HorizontalPager

如需创建左右滚动的分页器，请使用 HorizontalPager：

图 1. HorizontalPager 演示

// Display 10 items
val pagerState = rememberPagerState(pageCount = {
    10
})
HorizontalPager(state = pagerState) { page ->
    // Our page content
    Text(
        text = "Page: $page",
        modifier = Modifier.fillMaxWidth()
    )
}
PagerSnippets.kt

VerticalPager

如需创建可上下滚动的分页器，请使用 VerticalPager：

图 2. VerticalPager 演示

// Display 10 items
val pagerState = rememberPagerState(pageCount = {
    10
})
VerticalPager(state = pagerState) { page ->
    // Our page content
    Text(
        text = "Page: $page",
        modifier = Modifier.fillMaxWidth()
    )
}
PagerSnippets.kt

延迟创建

HorizontalPager 和 VerticalPager 中的页面会根据需要延迟组合和布局。当用户滚动浏览页面时，该可组合项会移除不再需要的所有页面。

在屏幕外加载更多网页

默认情况下，分页器仅加载屏幕上可见的网页。如需在屏幕外加载更多网页，请将 beyondBoundsPageCount 设置为大于零的值。

滚动到分页器中的某项内容

如需滚动到分页器中的某个页面，请使用 rememberPagerState() 创建一个 PagerState 对象，并将其作为 state 参数传递给分页器。您可以在 CoroutineScope 中对此状态调用 PagerState#scrollToPage()：

val pagerState = rememberPagerState(pageCount = {
    10
})
HorizontalPager(state = pagerState) { page ->
    // Our page content
    Text(
        text = "Page: $page",
        modifier = Modifier
            .fillMaxWidth()
            .height(100.dp)
    )
}

// scroll to page
val coroutineScope = rememberCoroutineScope()
Button(onClick = {
    coroutineScope.launch {
        // Call scroll to on pagerState
        pagerState.scrollToPage(5)
    }
}, modifier = Modifier.align(Alignment.BottomCenter)) {
    Text("Jump to Page 5")
}
PagerSnippets.kt

如果要为页面添加动画效果，请使用 PagerState#animateScrollToPage() 函数：

val pagerState = rememberPagerState(pageCount = {
    10
})

HorizontalPager(state = pagerState) { page ->
    // Our page content
    Text(
        text = "Page: $page",
        modifier = Modifier
            .fillMaxWidth()
            .height(100.dp)
    )
}

// scroll to page
val coroutineScope = rememberCoroutineScope()
Button(onClick = {
    coroutineScope.launch {
        // Call scroll to on pagerState
        pagerState.animateScrollToPage(5)
    }
}, modifier = Modifier.align(Alignment.BottomCenter)) {
    Text("Jump to Page 5")
}
PagerSnippets.kt

接收有关页面状态变化的通知

PagerState 有三个属性包含页面相关信息：currentPage、settledPage 和 targetPage。

• currentPage：最接近贴靠位置的页面。默认情况下，贴靠位置位于布局的开头。
• settledPage：不运行动画或滚动时的页码。这与 currentPage 属性不同，如果页面足够靠近贴靠位置，currentPage 会立即更新，但 settledPage 会保持不变，直到所有动画都完成运行。
• targetPage：滚动移动的建议停止位置。

您可以使用 snapshotFlow 函数观察这些变量的变化并做出反应。例如，如需在每次网页发生更改时发送分析事件，您可以执行以下操作：

val pagerState = rememberPagerState(pageCount = {
    10
})

LaunchedEffect(pagerState) {
    // Collect from the a snapshotFlow reading the currentPage
    snapshotFlow { pagerState.currentPage }.collect { page ->
        // Do something with each page change, for example:
        // viewModel.sendPageSelectedEvent(page)
        Log.d("Page change", "Page changed to $page")
    }
}

VerticalPager(
    state = pagerState,
) { page ->
    Text(text = "Page: $page")
}
PagerSnippets.kt

添加页面指示器

如需向页面添加指示器，请使用 PagerState 对象获取有关从页面数中选择的是哪个页面的信息，并绘制您的自定义指示器。

例如，如果您需要一个简单的圆形指示器，可以使用 pagerState.currentPage 重复圆形的数量，并根据页面是否选择更改圆形颜色：

val pagerState = rememberPagerState(pageCount = {
    4
})
HorizontalPager(
    state = pagerState,
    modifier = Modifier.fillMaxSize()
) { page ->
    // Our page content
    Text(
        text = "Page: $page",
    )
}
Row(
    Modifier
        .wrapContentHeight()
        .fillMaxWidth()
        .align(Alignment.BottomCenter)
        .padding(bottom = 8.dp),
    horizontalArrangement = Arrangement.Center
) {
    repeat(pagerState.pageCount) { iteration ->
        val color = if (pagerState.currentPage == iteration) Color.DarkGray else Color.LightGray
        Box(
            modifier = Modifier
                .padding(2.dp)
                .clip(CircleShape)
                .background(color)
                .size(16.dp)
        )
    }
}
PagerSnippets.kt

图 3. 在内容下方显示圆圈指示器的分页器

将内容滚动效果应用于内容

一个常见的用例是利用滚动位置对分页器项应用效果。如需了解某个网页距离当前所选网页有多远，您可以使用 PagerState.currentPageOffsetFraction。然后，您可以根据与所选页面的距离将转换效果应用于您的内容。

图 4. 对分页器内容应用转换

例如，如需根据项与中心的距离调整不透明度，请使用 Modifier.graphicsLayer 对分页器内的项更改 alpha：

val pagerState = rememberPagerState(pageCount = {
    4
})
HorizontalPager(state = pagerState) { page ->
    Card(
        Modifier
            .size(200.dp)
            .graphicsLayer {
                // Calculate the absolute offset for the current page from the
                // scroll position. We use the absolute value which allows us to mirror
                // any effects for both directions
                val pageOffset = (
                    (pagerState.currentPage - page) + pagerState
                        .currentPageOffsetFraction
                    ).absoluteValue

                // We animate the alpha, between 50% and 100%
                alpha = lerp(
                    start = 0.5f,
                    stop = 1f,
                    fraction = 1f - pageOffset.coerceIn(0f, 1f)
                )
            }
    ) {
        // Card content
    }
}
PagerSnippets.kt

自定义页面大小

默认情况下，HorizontalPager 和 VerticalPager 分别占据全宽或全高。您可以将 pageSize 变量设置为使用 Fixed、Fill（默认）或自定义大小计算。

例如，如需设置 100.dp 这一固定宽度的页面，请使用以下代码：

val pagerState = rememberPagerState(pageCount = {
    4
})
HorizontalPager(
    state = pagerState,
    pageSize = PageSize.Fixed(100.dp)
) { page ->
    // page content
}
PagerSnippets.kt

如需根据视口大小调整页面大小，请使用自定义页面大小计算方法。创建一个自定义 PageSize 对象，并将 availableSpace 除以 3，同时考虑项之间的间距：

private val threePagesPerViewport = object : PageSize {
    override fun Density.calculateMainAxisPageSize(
        availableSpace: Int,
        pageSpacing: Int
    ): Int {
        return (availableSpace - 2 * pageSpacing) / 3
    }
}
PagerSnippets.kt

内容内边距

HorizontalPager 和 VerticalPager 都支持更改内容内边距，从而让您能够影响页面的最大尺寸和对齐方式。

例如，设置 start 内边距会使页面朝末端对齐：

val pagerState = rememberPagerState(pageCount = {
    4
})
HorizontalPager(
    state = pagerState,
    contentPadding = PaddingValues(start = 64.dp),
) { page ->
    // page content
}
PagerSnippets.kt

将 start 和 end 内边距设置为同一个值，使项在水平方向上居中：

val pagerState = rememberPagerState(pageCount = {
    4
})
HorizontalPager(
    state = pagerState,
    contentPadding = PaddingValues(horizontal = 32.dp),
) { page ->
    // page content
}
PagerSnippets.kt

设置 end 内边距会让页面朝着起始位置对齐：

val pagerState = rememberPagerState(pageCount = {
    4
})
HorizontalPager(
    state = pagerState,
    contentPadding = PaddingValues(end = 64.dp),
) { page ->
    // page content
}
PagerSnippets.kt

您可以设置 top 和 bottom 值，以实现 VerticalPager 的类似效果。值 32.dp 仅在此处用作示例；您可以将每个内边距尺寸设置为任何值。

自定义滚动行为

默认的 HorizontalPager 和 VerticalPager 可组合项会指定滚动手势如何与分页器搭配使用。不过，您可以自定义和更改默认值，例如 pagerSnapDistance 或 flingBehavior。

吸附距离

默认情况下，HorizontalPager 和 VerticalPager 用于设置滑动手势一次可以滚动越过一页的页数上限。如需更改此设置，请在 flingBehavior 上设置 pagerSnapDistance：

val pagerState = rememberPagerState(pageCount = { 10 })

val fling = PagerDefaults.flingBehavior(
    state = pagerState,
    pagerSnapDistance = PagerSnapDistance.atMost(10)
)

Column(modifier = Modifier.fillMaxSize()) {
    HorizontalPager(
        state = pagerState,
        pageSize = PageSize.Fixed(200.dp),
        beyondBoundsPageCount = 10,
        flingBehavior = fling
    ) {
        PagerSampleItem(page = it)
    }
}
PagerSnippets.kt