如要以左右或上下的方式瀏覽內容,您可以分別使用 HorizontalPager
和 VerticalPager
可組合函式。這些可組合項與檢視系統中 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
設為大於零的值。
捲動至頁面控制項中的項目
如要捲動至頁面器中的特定頁面,請使用 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") }
如果您要為頁面加入動畫效果,請使用 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
可組合項會指定捲動手勢與頁面器搭配運作的方式。不過,您可以自訂及變更預設值,例如 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) } }
為您推薦
- 注意:系統會在 JavaScript 關閉時顯示連結文字
- Compose 中的 ConstraintLayout
- 圖形修飾符
- 將
CoordinatorLayout
遷移至 Compose