Compose でのページャー

コンテンツを左右または上下にフリップするには、それぞれ HorizontalPager コンポーザブルと VerticalPager コンポーザブルを使用します。これらのコンポーザブルには、ビューシステムの ViewPager と同様の関数があります。デフォルトでは、HorizontalPager が画面の全幅を占め、VerticalPager が全高を占め、ページャーは一度に 1 ページだけフリングします。これらのデフォルトはすべて構成可能です。

注: Compose ページャーは試験運用版です。問題がある場合は、Issue Tracker で報告してください。

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 を 0 より大きい値に設定します。

ページャーで目的の項目までスクロールします。

ページャー内の特定のページにスクロールするには、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 には、ページに関する情報を含む 3 つのプロパティ（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 や flingBehaviour などのデフォルトをカスタマイズして変更することは可能です。

スナップ距離

デフォルトでは、HorizontalPager と VerticalPager は、フリング操作で一度に 1 ページにスクロールできる最大ページ数を設定します。これを変更するには、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