Cómo migrar CoordinatorLayout a Compose

CoordinatorLayout es un ViewGroup que permite diseños complejos, superpuestos y anidados. Se usa como contenedor para habilitar interacciones específicas de Material Design, como la expansión o contracción de barras de herramientas y hojas inferiores, para las Views que contiene.

En Compose, el equivalente más cercano de un CoordinatorLayout es un Scaffold. Un Scaffold proporciona espacios de contenido para combinar componentes de Material en patrones e interacciones de pantalla comunes. En esta página, se describe cómo puedes migrar tu implementación de CoordinatorLayout para usar Scaffold en Compose.

Pasos de la migración

Para migrar CoordinatorLayout a Scaffold, sigue estos pasos:

  1. En el siguiente fragmento, el CoordinatorLayout contiene un AppBarLayout para incluir un ToolBar, un ViewPager y un FloatingActionButton. Comenta el CoordinatorLayout y sus elementos secundarios en la jerarquía de la IU, y agrega un ComposeView para reemplazarlo.

    <!--  <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. En tu Fragment o Activity, obtén una referencia al ComposeView que acabas de agregar y llama al método setContent en él. En el cuerpo del método, establece un Scaffold como su contenido:

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

  3. En el contenido de tu Scaffold, agrega el contenido principal de la pantalla. Dado que el contenido principal del XML anterior es un ViewPager2, usaremos un HorizontalPager, que es su equivalente en Compose. La lambda content del Scaffold también recibe una instancia de PaddingValues que se debe aplicar a la raíz del contenido. Puedes usar Modifier.padding para aplicar el mismo PaddingValues al HorizontalPager.

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

  4. Usa otros espacios de contenido que proporciona Scaffold para agregar más elementos de pantalla y migrar las Views secundarias restantes. Puedes usar el espacio topBar para agregar un TopAppBar y el espacio floatingActionButton para proporcionar un 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

Casos de uso comunes

Cómo contraer y expandir barras de herramientas

En el sistema de View, para contraer y expandir la barra de herramientas con CoordinatorLayout, usas un AppBarLayout como contenedor de la barra de herramientas. Luego, puedes especificar un Behavior a través de layout_behavior en XML en el elemento View desplazable asociado (como RecyclerView o NestedScrollView) para declarar cómo se contrae o expande la barra de herramientas a medida que te desplazas.

En Compose, puedes lograr un efecto similar con un TopAppBarScrollBehavior. Por ejemplo, para implementar una barra de herramientas que se contrae y expande de modo que aparezca cuando te desplazas hacia arriba, sigue estos pasos:

  1. Llama a TopAppBarDefaults.enterAlwaysScrollBehavior() para crear un objeto TopAppBarScrollBehavior.
  2. Proporciona el TopAppBarScrollBehavior creado al TopAppBar.

  3. Conecta el NestedScrollConnection a través de Modifier.nestedScroll en el Scaffold para que Scaffold pueda recibir eventos de desplazamiento anidado a medida que el contenido desplazable se desplaza hacia arriba o hacia abajo. De esta manera, la barra de la app contenida puede contraerse o expandirse de forma adecuada a medida que se desplaza el contenido.

    // 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

Personaliza el efecto de desplazamiento de expansión y contracción

Puedes proporcionar varios parámetros para enterAlwaysScrollBehavior y personalizar el efecto de animación de contracción o expansión. TopAppBarDefaults también proporciona otros TopAppBarScrollBehavior, como exitUntilCollapsedScrollBehavior, que solo expande la barra de la app cuando el contenido se desplaza hasta el final.

Para crear un efecto completamente personalizado (por ejemplo, un efecto de paralaje), también puedes crear tu propio NestedScrollConnection y desplazar la barra de herramientas manualmente a medida que se desplaza el contenido. Consulta el ejemplo de desplazamiento anidado en AOSP para ver un ejemplo de código.

Paneles laterales

Con Views, implementas un panel lateral de navegación con un DrawerLayout como vista raíz. A su vez, tu CoordinatorLayout es una vista secundaria de DrawerLayout. El DrawerLayout también contiene otra vista secundaria, como un NavigationView, para mostrar las opciones de navegación en el panel lateral.

En Compose, puedes implementar un panel lateral de navegación con el elemento ModalNavigationDrawer componible. ModalNavigationDrawer ofrece un espacio drawerContent para el panel lateral y un espacio content para el contenido de la pantalla.

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

Consulta Cajones para obtener más información.

Barras de notificaciones

Scaffold proporciona una ranura snackbarHost, que puede aceptar un elemento SnackbarHost componible para mostrar un Snackbar.

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

Consulta Snackbars para obtener más información.

Más información

Para obtener más información sobre cómo migrar un CoordinatorLayout a Compose, consulta los siguientes recursos: