如要以左右或上下的方式瀏覽內容,可以使用
這個
HorizontalPager
和
VerticalPager
可組合函式這些可組合項的功能與 View 系統中的 ViewPager
相似。根據預設,HorizontalPager
會占用整個畫面的寬度,VerticalPager
會占用整個畫面的高度,且分頁器每次只會擲送一個頁面。這些預設值皆可設定。
HorizontalPager
如要建立可水平左右捲動的分頁工具,請使用
HorizontalPager
:
// Display 10 items val pagerState = rememberPagerState(pageCount = { 10 }) HorizontalPager(state = pagerState) { page -> // Our page content Text( text = "Page: $page", modifier = Modifier.fillMaxWidth() ) }
VerticalPager
如要建立可以上下捲動的頁面工具,請使用 VerticalPager
:
// Display 10 items val pagerState = rememberPagerState(pageCount = { 10 }) VerticalPager(state = pagerState) { page -> // Our page content Text( text = "Page: $page", modifier = Modifier.fillMaxWidth() ) }
延遲建立
HorizontalPager
和 VerticalPager
中的頁面會在需要時延遲組合和版面配置。當使用者捲動頁面時,可組合項會移除不再需要的任何頁面。
載入更多畫面外網頁
根據預設,分頁器只會載入畫面上顯示的頁面。如要載入更多畫面外的網頁,請將 beyondBoundsPageCount
設為大於零的值。
捲動至頁面控制項中的項目
如要在頁面工具中捲動至特定頁面,請建立
PagerState
物件
rememberPagerState()
並將其做為 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") }
如果您要建立頁面動畫,請使用
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") }
接收網頁狀態變更通知
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") }
新增頁面指標
如要在頁面中加入指標,請使用 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) ) } }
為內容套用項目捲動效果
常見的做法是使用捲動位置將效果套用至頁面控制項
項目。如要瞭解某個網頁與目前選取的網頁距離有多遠,您可以使用 PagerState.currentPageOffsetFraction
。接著可以根據距離,為內容套用變形效果
即可產生相應的文件
舉例來說,如要根據項目與中心的距離調整項目的不透明度,請在分頁器內的項目上使用 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 } }
自訂頁面大小
根據預設,HorizontalPager
和 VerticalPager
會採用完整寬度或
而這三個高度。您可以將 pageSize
變數設為 Fixed
、Fill
(預設值) 或自訂大小計算值。
舉例來說,如要將網頁的固定寬度設為 100.dp
,請按照下列步驟操作:
val pagerState = rememberPagerState(pageCount = { 4 }) HorizontalPager( state = pagerState, pageSize = PageSize.Fixed(100.dp) ) { page -> // page content }
如要根據可視區域大小調整網頁大小,請使用自訂的網頁大小計算方式。建立自訂 PageSize
物件,並將 availableSpace
除以三,考量項目間的間距:
private val threePagesPerViewport = object : PageSize { override fun Density.calculateMainAxisPageSize( availableSpace: Int, pageSpacing: Int ): Int { return (availableSpace - 2 * pageSpacing) / 3 } }
內容間距
HorizontalPager
和 VerticalPager
都支援變更內容邊框間距,讓您影響網頁的最大大小和對齊方式。
舉例來說,設定 start
邊框間距可將頁面靠近末端:
val pagerState = rememberPagerState(pageCount = { 4 }) HorizontalPager( state = pagerState, contentPadding = PaddingValues(start = 64.dp), ) { page -> // page content }
將 start
和 end
邊框間距設為相同的值,即可將項目置中
水平:
val pagerState = rememberPagerState(pageCount = { 4 }) HorizontalPager( state = pagerState, contentPadding = PaddingValues(horizontal = 32.dp), ) { page -> // page content }
設定 end
邊框間距可將頁面對齊至開頭:
val pagerState = rememberPagerState(pageCount = { 4 }) HorizontalPager( state = pagerState, contentPadding = PaddingValues(end = 64.dp), ) { page -> // page content }
您可以設定 top
和 bottom
值,為 VerticalPager
取得類似的效果。這裡的 32.dp
值僅供示範,您可以將每個邊框間距維度設為任何值。
自訂捲動行為
預設的 HorizontalPager
和 VerticalPager
可組合項會指定捲動手勢如何與 pager 搭配運作。不過,你可以自訂及變更
預設值,例如 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), beyondViewportPageCount = 10, flingBehavior = fling ) { PagerSampleItem(page = it) } }
為您推薦
- 注意:系統會在 JavaScript 關閉時顯示連結文字
- Compose 中的 ConstraintLayout
- 圖形修飾符
- 將
CoordinatorLayout
遷移至 Compose