CoordinatorLayout を Compose に移行する

CoordinatorLayout は、複雑で重なり合ったネストされたレイアウトを可能にする ViewGroup です。このコンテナは、内部に含まれるビューに対して、ツールバーやボトムシートの展開や折りたたみなど、マテリアル デザインの特定の操作を可能にするためのコンテナとして使用されます。

Compose において、CoordinatorLayout に最も近いものは Scaffold です。Scaffold は、マテリアル コンポーネントを共通の画面パターンと操作に統合するためのコンテンツ スロットを提供します。このページでは、Compose で Scaffold を使用するように CoordinatorLayout 実装を移行する方法について説明します。

移行手順

CoordinatorLayout を Scaffold に移行する手順は次のとおりです。

  1. 以下のスニペットでは、CoordinatorLayout に AppBarLayout が含まれ、ToolBar、ViewPager、FloatingActionButton が含まれています。UI 階層から CoordinatorLayout とその子をコメントアウトし、ComposeView を追加して置き換えます。

    <!--  <androidx.coordinatorlayout.widget.CoordinatorLayout-->
<!--      android:id="@+id/coordinator_layout"-->
<!--      android:layout_width="match_parent"-->
<!--      android:layout_height="match_parent"-->
<!--      android:fitsSystemWindows="true">-->

<!--    <androidx.compose.ui.platform.ComposeView-->
<!--        android:id="@+id/compose_view"-->
<!--        android:layout_width="match_parent"-->
<!--        android:layout_height="match_parent"-->
<!--        app:layout_behavior="@string/appbar_scrolling_view_behavior" />-->

<!--    <com.google.android.material.appbar.AppBarLayout-->
<!--        android:id="@+id/app_bar_layout"-->
<!--        android:layout_width="match_parent"-->
<!--        android:layout_height="wrap_content"-->
<!--        android:fitsSystemWindows="true"-->
<!--        android:theme="@style/Theme.Sunflower.AppBarOverlay">-->

    <!-- AppBarLayout contents here -->

<!--    </com.google.android.material.appbar.AppBarLayout>-->

<!--  </androidx.coordinatorlayout.widget.CoordinatorLayout>-->

<androidx.compose.ui.platform.ComposeView
    android:id="@+id/compose_view"
    android:layout_width="match_parent"
    android:layout_height="match_parent" />

  2. Fragment または Activity で、先ほど追加した ComposeView への参照を取得し、その setContent メソッドを呼び出します。メソッドの本体で、Scaffold をコンテンツとして設定します。

    composeView.setContent {
    Scaffold(Modifier.fillMaxSize()) { contentPadding ->
        // Scaffold contents
        // ...
    }
}
    MigrationCommonScenariosSnippets.kt

  3. Scaffold のコンテンツに、画面の主要コンテンツを追加します。上記の XML のプライマリ コンテンツは ViewPager2 であるため、Compose と同等の HorizontalPager を使用します。Scaffold の content ラムダは、コンテンツ ルートに適用する必要がある PaddingValues のインスタンスも受け取ります。Modifier.padding を使用して、同じ PaddingValues を HorizontalPager に適用できます。

    composeView.setContent {
    Scaffold(Modifier.fillMaxSize()) { contentPadding ->
        val pagerState = rememberPagerState {
            10
        }
        HorizontalPager(
            state = pagerState,
            modifier = Modifier.padding(contentPadding)
        ) { /* Page contents */ }
    }
}
    MigrationCommonScenariosSnippets.kt

  4. Scaffold に用意されている他のコンテンツ スロットを使用して、画面要素を追加し、残りの子ビューを移行する。topBar スロットを使用して TopAppBar を追加し、floatingActionButton スロットを使用して FloatingActionButton を提供できます。

    composeView.setContent {
    Scaffold(
        Modifier.fillMaxSize(),
        topBar = {
            TopAppBar(
                title = {
                    Text("My App")
                }
            )
        },
        floatingActionButton = {
            FloatingActionButton(
                onClick = { /* Handle click */ }
            ) {
                Icon(
                    Icons.Filled.Add,
                    contentDescription = "Add Button"
                )
            }
        }
    ) { contentPadding ->
        val pagerState = rememberPagerState {
            10
        }
        HorizontalPager(
            state = pagerState,
            modifier = Modifier.padding(contentPadding)
        ) { /* Page contents */ }
    }
}
    MigrationCommonScenariosSnippets.kt

一般的なユースケース

ツールバーの折りたたみ / 展開

View システムで、CoordinatorLayout を使用してツールバーを折りたたんだり開くには、ツールバーのコンテナとして AppBarLayout を使用します。その後、関連するスクロール可能なビュー（RecyclerView や NestedScrollView など）で XML で Behavior～layout_behavior を指定して、スクロール時にツールバーの折りたたみ/展開方法を宣言できます。

Compose では、TopAppBarScrollBehavior を使用して同様の効果を実現できます。たとえば、折りたたみ/展開ツールバーを実装して、上にスクロールしたときにツールバーが表示されるようにするには、次の手順を行います。

  1. TopAppBarDefaults.enterAlwaysScrollBehavior() を呼び出して TopAppBarScrollBehavior を作成します。
  2. 作成した TopAppBarScrollBehavior を TopAppBar に提供します。

  3. Scaffold の Modifier.nestedScroll を介して NestedScrollConnection を接続して、スクロール可能なコンテンツが上下にスクロールしたときに Scaffold がネストされたスクロール イベントを受け取れるようにします。これにより、包含アプリバーは、コンテンツのスクロールに応じて適切に折りたたまれたり、開いたりします。

    // 1. Create the TopAppBarScrollBehavior
val scrollBehavior = TopAppBarDefaults.enterAlwaysScrollBehavior()

Scaffold(
    topBar = {
        TopAppBar(
            title = {
                Text("My App")
            },
            // 2. Provide scrollBehavior to TopAppBar
            scrollBehavior = scrollBehavior
        )
    },
    // 3. Connect the scrollBehavior.nestedScrollConnection to the Scaffold
    modifier = Modifier
        .fillMaxSize()
        .nestedScroll(scrollBehavior.nestedScrollConnection)
) { contentPadding ->
    /* Contents */
    // ...
}
    MigrationCommonScenariosSnippets.kt

折りたたみ/展開スクロール効果をカスタマイズする

enterAlwaysScrollBehavior に複数のパラメータを指定して、折りたたみ/展開アニメーション効果をカスタマイズできます。TopAppBarDefaults には、exitUntilCollapsedScrollBehavior などの他の TopAppBarScrollBehavior もあり、コンテンツが一番下までスクロールされたときにのみアプリバーが展開されます。

完全なカスタム効果（視差効果など）を作成するには、独自の NestedScrollConnection を作成し、コンテンツのスクロールに合わせてツールバーを手動でオフセットすることもできます。コードサンプルについては、AOSP のネストされたスクロール サンプルをご覧ください。

ドロワー

ビューでは、DrawerLayout をルートビューとして使用して、ナビゲーション ドロワーを実装します。また、CoordinatorLayout は DrawerLayout の子ビューになります。DrawerLayout には、ドロワーにナビゲーション オプションを表示する NavigationView などの別の子ビューも含まれています。

Compose では、ModalNavigationDrawer コンポーザブルを使用してナビゲーション ドロワーを実装できます。ModalNavigationDrawer は、ドロワー用の drawerContent スロットと、画面コンテンツ用の content スロットを提供します。

ModalNavigationDrawer(
    drawerContent = {
        ModalDrawerSheet {
            Text("Drawer title", modifier = Modifier.padding(16.dp))
            Divider()
            NavigationDrawerItem(
                label = { Text(text = "Drawer Item") },
                selected = false,
                onClick = { /*TODO*/ }
            )
            // ...other drawer items
        }
    }
) {
    Scaffold(Modifier.fillMaxSize()) { contentPadding ->
        // Scaffold content
        // ...
    }
}
MigrationCommonScenariosSnippets.kt

詳しくは、ドロワーをご覧ください。

スナックバー

Scaffold は、Snackbar を表示する SnackbarHost コンポーザブルを受け入れる snackbarHost スロットを提供します。

val scope = rememberCoroutineScope()
val snackbarHostState = remember { SnackbarHostState() }
Scaffold(
    snackbarHost = {
        SnackbarHost(hostState = snackbarHostState)
    },
    floatingActionButton = {
        ExtendedFloatingActionButton(
            text = { Text("Show snackbar") },
            icon = { Icon(Icons.Filled.Image, contentDescription = "") },
            onClick = {
                scope.launch {
                    snackbarHostState.showSnackbar("Snackbar")
                }
            }
        )
    }
) { contentPadding ->
    // Screen content
    // ...
}
MigrationCommonScenariosSnippets.kt

詳しくは、スナックバーをご覧ください。

さらに詳しく

CoordinatorLayout から Compose への移行について詳しくは、以下のリソースをご覧ください。