Inserciones de ventana en Compose

La plataforma de Android se encarga de diseñar la IU del sistema, como la barra de estado y la de navegación. Esta IU del sistema se muestra independientemente de la app que use el usuario. WindowInsets proporciona información sobre la IU del sistema para garantizar que tu app se dibuje en el área correcta y que la IU del sistema no oscurezca la IU.

Ir de borde a borde para dibujar detrás de las barras del sistema
Figura 1: Ir de borde a borde para dibujar detrás de las barras del sistema

De forma predeterminada, la IU de tu app se limita a su distribución dentro de la IU del sistema, como la barra de estado y la de navegación. Esto garantiza que el contenido de tu app no esté oculto por elementos de la IU del sistema.

Sin embargo, recomendamos que las apps habiliten la opción de mostrar contenido en estas áreas donde también se muestra la IU del sistema, lo que genera una experiencia del usuario más fluida y permite que tu app aproveche al máximo el espacio de ventana disponible. Esto también permite que las apps tengan una animación junto con la IU del sistema, especialmente cuando se muestra y se oculta el teclado en pantalla.

Habilitar la visualización en estas regiones y mostrar el contenido detrás de la IU del sistema se denomina van de borde a borde. En esta página, aprenderás sobre los diferentes tipos de inserciones, cómo habilitar la opción de borde a borde y cómo usar las APIs de inserción para animar tu IU y evitar que se oculten partes de tu app.

Aspectos básicos de la inserción

Cuando una app está de borde a borde, debes asegurarte de que la IU del sistema no oculte el contenido y las interacciones importantes. Por ejemplo, si un botón se coloca detrás de la barra de navegación, es posible que el usuario no pueda hacer clic en él.

El tamaño de la IU del sistema y la información sobre dónde se coloca se especifican a través de inserciones.

Cada parte de la IU del sistema tiene un tipo de inserción correspondiente que describe su tamaño y dónde se coloca. Por ejemplo, las inserciones de la barra de estado proporcionan el tamaño y la posición de la barra de estado, mientras que las inserciones de la barra de navegación proporcionan el tamaño y la posición de la barra de navegación. Cada tipo de inserción consta de cuatro dimensiones de píxeles: superior, izquierdo, derecho e inferior. Estas dimensiones especifican cuánto se extiende la IU del sistema desde los lados correspondientes de la ventana de la app. Para evitar la superposición con ese tipo de IU del sistema, por lo tanto, la IU de la app debe insertarse en esa cantidad.

Estos tipos de inserciones integrados de Android están disponibles a través de WindowInsets:

WindowInsets.statusBars

Inserciones que describen las barras de estado Estas son las barras superiores de la IU del sistema que contienen íconos de notificaciones y otros indicadores.

WindowInsets.statusBarsIgnoringVisibility

La barra de estado se inserta cuando están visibles. Si las barras de estado están ocultas (debido al modo de pantalla completa envolvente), las inserciones de la barra de estado principal estarán vacías, pero no lo estarán.

WindowInsets.navigationBars

Las inserciones que describen las barras de navegación Son las barras de la IU del sistema en el lado izquierdo, derecho o inferior del dispositivo, que describen la barra de tareas o los íconos de navegación. Estas pueden cambiar en el tiempo de ejecución en función del método de navegación preferido del usuario y la interacción con la barra de tareas.

WindowInsets.navigationBarsIgnoringVisibility

Las inserciones de la barra de navegación para cuando estén visibles Si las barras de navegación están ocultas (debido al modo de pantalla completa envolvente), las inserciones de la barra de navegación principal estarán vacías, pero no lo estarán.

WindowInsets.captionBar

Es la inserción que describe la decoración de la ventana de la IU del sistema en una ventana de formato libre, como la barra de título superior.

WindowInsets.captionBarIgnoringVisibility

La barra de subtítulos se inserta para cuando estén visibles. Si las barras de subtítulos están ocultas, las inserciones principales de la barra de subtítulos estarán vacías, pero no lo estarán.

WindowInsets.systemBars

Es la unión de las inserciones de la barra del sistema, que incluyen las barras de estado, de navegación y de subtítulos.

WindowInsets.systemBarsIgnoringVisibility

La barra del sistema se inserta para cuando están visibles. Si las barras del sistema están ocultas (debido al modo de pantalla completa envolvente), las inserciones de la barra principal del sistema estarán vacías, pero no estarán vacías.

WindowInsets.ime

Inserciones que describen la cantidad de espacio en la parte inferior que ocupa el teclado en pantalla.

WindowInsets.imeAnimationSource

Son las inserciones que describen la cantidad de espacio que ocupaba el teclado en pantalla antes de la animación del teclado actual.

WindowInsets.imeAnimationTarget

Son las inserciones que describen la cantidad de espacio que ocupará el teclado en pantalla después de la animación del teclado actual.

WindowInsets.tappableElement

Es un tipo de inserciones que describen información más detallada sobre la IU de navegación, que proporciona la cantidad de espacio en el que el sistema controlará los "toques", y no la app. En el caso de las barras de navegación transparentes con navegación por gestos, algunos elementos de la app pueden presionarse a través de la IU de navegación del sistema.

WindowInsets.tappableElementIgnoringVisibility

Las inserciones de elementos que se pueden presionar para cuando son visibles Si los elementos que se pueden presionar están ocultos (debido al modo de pantalla completa envolvente), las inserciones de elementos principales que se pueden presionar estarán vacías, pero estas inserciones no estarán vacías.

WindowInsets.systemGestures

Las inserciones que representan la cantidad de inserciones en las que el sistema interceptará gestos para la navegación Las apps pueden especificar manualmente el control de una cantidad limitada de estos gestos a través de Modifier.systemGestureExclusion.

WindowInsets.mandatorySystemGestures

Un subconjunto de los gestos del sistema que el sistema siempre controlará y que no se pueden inhabilitar a través de Modifier.systemGestureExclusion.

WindowInsets.displayCutout

Las inserciones que representan la cantidad de espaciado necesario para evitar superponerse con un corte de pantalla (muesca o estenopeica).

WindowInsets.waterfall

Se muestran las inserciones que representan las áreas curvas de una cascada. Una pantalla de cascada tiene áreas curvas a lo largo de los bordes de la pantalla donde la pantalla comienza a ajustarse a los lados del dispositivo.

Estos se resumen en tres tipos de inserción “seguros” que garantizan que el contenido no esté oscurecido:

Estos tipos de inserción "seguros" protegen el contenido de diferentes maneras, según las inserciones de plataforma subyacentes:

  • Usa WindowInsets.safeDrawing para proteger el contenido que no debe dibujarse debajo de ninguna IU del sistema. Este es el uso más común de las inserciones: para evitar dibujar contenido que esté oculto por la IU del sistema (ya sea de forma parcial o total).
  • Usa WindowInsets.safeGestures para proteger el contenido con gestos. De esta manera, se evita que los gestos del sistema entren en conflicto con los de la app (como los de las hojas inferiores, los carruseles o los juegos).
  • Usa WindowInsets.safeContent como una combinación de WindowInsets.safeDrawing y WindowInsets.safeGestures para garantizar que el contenido no tenga superposición visual ni de gestos.

Configuración de inserciones

Para permitir que tu app controle por completo dónde dibuja contenido, sigue estos pasos de configuración. Sin estos pasos, tu app podría dibujar colores negros o sólidos detrás de la IU del sistema, o no animarse de forma síncrona con el teclado en pantalla.

  1. Llama a enableEdgeToEdge() en Activity.onCreate. Esta llamada solicita que tu app se muestre detrás de la IU del sistema. Luego, tu app controlará cómo se usan esas inserciones para ajustar la IU.

  2. Configura android:windowSoftInputMode="adjustResize" en la entrada AndroidManifest.xml de tu actividad. Esta configuración permite que tu app reciba el tamaño del IME de software como inserciones, que puedes usar para rellenar y distribuir el contenido de manera adecuada cuando el IME aparece y desaparece en tu app.

    <!-- in your AndroidManifest.xml file: -->
<activity
  android:name=".ui.MainActivity"
  android:label="@string/app_name"
  android:windowSoftInputMode="adjustResize"
  android:theme="@style/Theme.MyApplication"
  android:exported="true">

APIs de Compose

Una vez que tu actividad haya tomado el control del control de todas las inserciones, podrás usar las APIs de Compose para asegurarte de que el contenido no esté oscurecido y que los elementos interactivos no se superpongan con la IU del sistema. Estas APIs también sincronizan el diseño de tu app con los cambios en la inserción.

Por ejemplo, este es el método más básico para aplicar las inserciones al contenido de toda la app:

override fun onCreate(savedInstanceState: Bundle?) {
    super.onCreate(savedInstanceState)

    enableEdgeToEdge()

    setContent {
        Box(Modifier.safeDrawingPadding()) {
            // the rest of the app
        }
    }
}
InsetsSnippets.kt

Este fragmento aplica las inserciones de ventana safeDrawing como relleno en todo el contenido de la app. Si bien esto garantiza que los elementos interactivos no se superpongan con la IU del sistema, también significa que ninguna de las apps se dibujará detrás de la IU del sistema para lograr un efecto de borde a borde. Para aprovechar al máximo la ventana completa, debes ajustar dónde se aplican las inserciones pantalla por pantalla o componente por componente.

Todos estos tipos de inserciones se animan automáticamente con animaciones IME que se adaptaron al nivel de API 21. Por extensión, todos los diseños que usan estas inserciones también se animan automáticamente a medida que cambian los valores de la inserción.

Existen dos formas principales de usar estos tipos de inserción para ajustar tus diseños componibles: modificadores de padding y modificadores de tamaño de inserción.

Modificadores de padding

Modifier.windowInsetsPadding(windowInsets: WindowInsets) aplica las inserciones de ventana determinadas como padding, y actúa como lo haría Modifier.padding. Por ejemplo, Modifier.windowInsetsPadding(WindowInsets.safeDrawing) aplica las inserciones de dibujo seguras como relleno en los 4 lados.

También hay varios métodos de utilidad integrados para los tipos de inserción más comunes. Modifier.safeDrawingPadding() es uno de esos métodos, que equivale a Modifier.windowInsetsPadding(WindowInsets.safeDrawing). Hay modificadores análogos para los otros tipos de inserción.

Modificadores de tamaño de inserción

Los siguientes modificadores aplican una cantidad de inserciones de ventana configurando el tamaño del componente para que sea el tamaño de las inserciones:

Modifier.windowInsetsStartWidth(windowInsets: WindowInsets)

Aplica el lado inicial de windowInsets como el ancho (como Modifier.width).

Modifier.windowInsetsEndWidth(windowInsets: WindowInsets)

Aplica el extremo del elemento windowInsets como el ancho (como Modifier.width).

Modifier.windowInsetsTopHeight(windowInsets: WindowInsets)

Aplica el lado superior de windowInsets como la altura (como Modifier.height).

Modifier.windowInsetsBottomHeight(windowInsets: WindowInsets)

Aplica el lado inferior de windowInsets como la altura (como Modifier.height).

Estos modificadores son especialmente útiles para ajustar el tamaño de un Spacer que ocupa el espacio de inserciones:

LazyColumn(
    Modifier.imePadding()
) {
    // Other content
    item {
        Spacer(
            Modifier.windowInsetsBottomHeight(
                WindowInsets.systemBars
            )
        )
    }
}
InsetsSnippets.kt

Inserción de consumo

Los modificadores de padding de inserción (windowInsetsPadding y asistentes como safeDrawingPadding) consumen automáticamente la parte de las inserciones que se aplican como padding. Cuando profundizas en el árbol de composición, los modificadores de padding de inserciones anidados y los modificadores de tamaño de inserción saben que parte de estas ya fueron consumidas por modificadores de padding de inserción externos y evitan usar la misma parte de las inserciones más de una vez, lo que generaría demasiado espacio adicional.

Los modificadores de tamaño de inserción también evitan usar la misma parte de las inserciones más de una vez si estas ya se consumieron. Sin embargo, como cambian de tamaño directamente, no consumen las inserciones.

Como resultado, los modificadores de padding de anidación cambian automáticamente la cantidad de padding que se aplica a cada elemento componible.

En el mismo ejemplo de LazyColumn que antes, el modificador imePadding cambia el tamaño de LazyColumn. Dentro de LazyColumn, el último elemento tiene el tamaño de la altura de la parte inferior de las barras del sistema:

LazyColumn(
    Modifier.imePadding()
) {
    // Other content
    item {
        Spacer(
            Modifier.windowInsetsBottomHeight(
                WindowInsets.systemBars
            )
        )
    }
}
InsetsSnippets.kt

Cuando se cierra el IME, el modificador imePadding() no aplica padding, ya que el IME no tiene altura. Como el modificador imePadding() no aplica padding, no se consumen las inserciones, y la altura de Spacer será el tamaño del lado inferior de las barras del sistema.

Cuando se abre el IME, las inserciones de IME se animan para coincidir con el tamaño del IME, y el modificador imePadding() comienza a aplicar padding inferior para cambiar el tamaño de LazyColumn cuando se abre el IME. A medida que el modificador imePadding() comienza a aplicar padding inferior, también comienza a consumir esa cantidad de inserciones. Por lo tanto, la altura de Spacer comienza a disminuir, dado que el modificador imePadding() ya aplicó el espaciado de las barras del sistema. Una vez que el modificador imePadding() aplica una cantidad de padding inferior que es mayor que las barras del sistema, la altura de Spacer es cero.

Cuando se cierra el IME, los cambios ocurren a la inversa: Spacer comienza a expandirse desde una altura de cero una vez que imePadding() aplica menos que la parte inferior de las barras del sistema, hasta que, finalmente, Spacer coincide con la altura de la parte inferior de las barras del sistema una vez que el IME está completamente animado.

Figura 2: Columna diferida de borde a borde con TextField

Este comportamiento se logra a través de la comunicación entre todos los modificadores windowInsetsPadding y puede influir de otras maneras.

Modifier.consumeWindowInsets(insets: WindowInsets) también consume inserciones de la misma manera que Modifier.windowInsetsPadding, pero no las aplica como relleno. Esto resulta útil en combinación con los modificadores de tamaño de inserción para indicarles a los elementos del mismo nivel que una cierta cantidad de inserciones ya se consumió:

Column(Modifier.verticalScroll(rememberScrollState())) {
    Spacer(Modifier.windowInsetsTopHeight(WindowInsets.systemBars))

    Column(
        Modifier.consumeWindowInsets(
            WindowInsets.systemBars.only(WindowInsetsSides.Vertical)
        )
    ) {
        // content
        Spacer(Modifier.windowInsetsBottomHeight(WindowInsets.ime))
    }

    Spacer(Modifier.windowInsetsBottomHeight(WindowInsets.systemBars))
}
InsetsSnippets.kt

Modifier.consumeWindowInsets(paddingValues: PaddingValues) se comporta de manera muy similar a la versión con un argumento WindowInsets, pero toma un PaddingValues arbitrario para consumir. Esto resulta útil para informar a los elementos secundarios cuando algún otro mecanismo proporciona padding o espaciado en lugar de los modificadores de padding de inserción, como un Modifier.padding común o espaciadores de altura fijos:

@OptIn(ExperimentalLayoutApi::class)
Column(Modifier.padding(16.dp).consumeWindowInsets(PaddingValues(16.dp))) {
    // content
    Spacer(Modifier.windowInsetsBottomHeight(WindowInsets.ime))
}
InsetsSnippets.kt

En los casos en que se necesiten las inserciones de ventana sin procesar sin consumo, usa los valores WindowInsets directamente o WindowInsets.asPaddingValues() para mostrar un PaddingValues de las inserciones que no se ven afectadas por el consumo. Sin embargo, debido a las advertencias que se mencionan a continuación, es preferible usar los modificadores de relleno de inserciones de ventana y los modificadores de tamaño de las inserciones de ventana siempre que sea posible.

Fases de inserciones y Jetpack Compose

Compose usa las APIs principales de AndroidX subyacentes para actualizar y animar las inserciones, que usan las APIs de la plataforma subyacentes que administran las inserciones. Debido a ese comportamiento de la plataforma, las inserciones tienen una relación especial con las fases de Jetpack Compose.

El valor de las inserciones se actualiza después de la fase de composición, pero antes de la fase de diseño. Esto significa que la lectura del valor de las inserciones en la composición generalmente usa un valor de las inserciones que está un fotograma tarde. Los modificadores integrados que se describen en esta página están compilados para retrasar el uso de los valores de las inserciones hasta la fase de diseño, lo que garantiza que los valores de inserción se usen en el mismo marco a medida que se actualizan.

Animaciones del IME del teclado con WindowInsets

Puedes aplicar Modifier.imeNestedScroll() a un contenedor de desplazamiento para abrir y cerrar el IME automáticamente cuando te desplazas a la parte inferior del contenedor.

class WindowInsetsExampleActivity : AppCompatActivity() {
    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)

        WindowCompat.setDecorFitsSystemWindows(window, false)

        setContent {
            MaterialTheme {
                MyScreen()
            }
        }
    }
}

@OptIn(ExperimentalLayoutApi::class)
@Composable
fun MyScreen() {
    Box {
        LazyColumn(
            modifier = Modifier
                .fillMaxSize() // fill the entire window
                .imePadding() // padding for the bottom for the IME
                .imeNestedScroll(), // scroll IME at the bottom
            content = { }
        )
        FloatingActionButton(
            modifier = Modifier
                .align(Alignment.BottomEnd)
                .padding(16.dp) // normal 16dp of padding for FABs
                .navigationBarsPadding() // padding for navigation bar
                .imePadding(), // padding for when IME appears
            onClick = { }
        ) {
            Icon(imageVector = Icons.Filled.Add, contentDescription = "Add")
        }
    }
}
MigrationOtherConsiderationsSnippets.kt

Animación que muestra un elemento de IU que se desplaza desde arriba hacia abajo a fin de dejar lugar para un teclado.

Figura 1: Animaciones IME

Compatibilidad con la inserción para componentes de Material 3

Para facilitar su uso, muchos de los elementos integrados de Material 3 componibles (androidx.compose.material3) controlan las inserciones, según la forma en que se colocan en tu app, según las especificaciones de Material.

Control de inserción de elementos componibles

A continuación, se muestra una lista de los componentes de Material que controlan automáticamente las inserciones.

Barras de la app

Contenedores de contenido

Scaffold

De forma predeterminada, Scaffold proporciona inserciones como el parámetro paddingValues para que las consumas y las uses. Scaffold no aplica las inserciones al contenido. Esta es tu responsabilidad. Por ejemplo, para consumir estas inserciones con un LazyColumn dentro de un Scaffold:

Scaffold { innerPadding ->
    // innerPadding contains inset information for you to use and apply
    LazyColumn(
        // consume insets as scaffold doesn't do it by default
        modifier = Modifier.consumeWindowInsets(innerPadding),
        contentPadding = innerPadding
    ) {
        items(count = 100) {
            Box(
                Modifier
                    .fillMaxWidth()
                    .height(50.dp)
                    .background(colors[it % colors.size])
            )
        }
    }
}
InsetsSnippets.kt

Anula las inserciones predeterminadas

Puedes cambiar el parámetro windowInsets que se pasa al elemento componible para configurar su comportamiento. Este parámetro puede ser un tipo diferente de inserción de ventana para aplicar, o bien puede inhabilitarse pasando una instancia vacía: WindowInsets(0, 0, 0, 0).

Por ejemplo, para inhabilitar el control de inserciones en LargeTopAppBar, configura el parámetro windowInsets en una instancia vacía:

LargeTopAppBar(
    windowInsets = WindowInsets(0, 0, 0, 0),
    title = {
        Text("Hi")
    }
)
InsetsSnippets.kt

Interoperabilidad con las inserciones del sistema de View

Es posible que debas anular las inserciones predeterminadas si la pantalla tiene código de Views y de Compose en la misma jerarquía. En este caso, debes ser explícito en cuanto a cuál debe consumir las inserciones y cuál debe ignorarlas.

Por ejemplo, si tu diseño más externo es de Android View, debes consumir las inserciones del sistema de View y, luego, ignorarlas para Compose. Como alternativa, si el diseño más externo es un elemento componible, debes consumir las inserciones en Compose y rellenar los elementos componibles AndroidView según corresponda.

De forma predeterminada, cada ComposeView consume todas las inserciones en el nivel de consumo WindowInsetsCompat. Para cambiar este comportamiento predeterminado, establece ComposeView.consumeWindowInsets en false.

Recursos

  • Now in Android: Es una app para Android completamente funcional compilada por completo con Kotlin y Jetpack Compose.