Mostre conteúdo de ponta a ponta no app e processe encartes de janela no Compose

A plataforma Android é responsável por desenhar a IU do sistema, como o barra de status e de navegação. Essa interface do sistema é exibida independentemente do app que o usuário está usando.

WindowInsets fornece informações sobre a interface do sistema para garantir que o app seja renderizado na área correta e que a interface não seja obscurecida pela interface do sistema.

Como usar ponta a ponta para desenhar por trás das barras do sistema
Figura 1. Use o recurso de ponta a ponta para desenhar por trás das barras do sistema.

No Android 14 (nível 34 da API) e versões anteriores, a interface do app não é renderizada abaixo das barras do sistema e dos cortes de tela por padrão.

No Android 15 (nível 35 da API) e versões mais recentes, o app é renderizado abaixo do sistema barras e cortes de tela quando o app for direcionado ao SDK 35. Isso resulta em uma experiência do usuário mais integrada e permite que o app aproveite ao máximo o espaço da janela disponível.

A exibição de conteúdo atrás da interface do sistema é chamada de de ponta a ponta. Nesta página, você vai aprender sobre os diferentes tipos de insets, como ir de borda a borda e como usar as APIs inset para animar a interface e garantir que o conteúdo do app não seja obscurecido por elementos da interface do sistema.

Princípios básicos do encarte

Quando um aplicativo vai de ponta a ponta, você precisa garantir que o conteúdo importante e interações não são obscurecidas pela interface do sistema. Por exemplo, se um botão for colocado atrás da barra de navegação, o usuário não poderá clicar nele.

O tamanho da interface do sistema e as informações sobre onde ela é colocada são especificados por insets.

Cada parte da interface do sistema tem um tipo correspondente de inseto que descreve o tamanho e o local em que ele é colocado. Por exemplo, os encartes da barra de status fornecem o tamanho e a posição da barra de status, enquanto os encartes da barra de navegação fornecem o tamanho e a posição da barra de navegação. Cada tipo de encarte consiste em quatro dimensões em pixels: superior, esquerda, direita e inferior. Essas dimensões especificam até onde a interface do sistema se estende dos lados correspondentes da janela do app. Para evitar a sobreposição com esse tipo de interface do sistema, a interface do app precisa ser inserida nesse valor.

Esses tipos de encarte integrados do Android estão disponíveis pelo WindowInsets:

WindowInsets.statusBars

Os insetos descrevem as barras de status. Essas são as barras de interface superiores do sistema que contêm ícones de notificação e outros indicadores.

WindowInsets.statusBarsIgnoringVisibility

Os encartes da barra de status para quando ficam visíveis. Se as barras de status estiverem ocultas (devido ao entrar no modo de tela cheia imersivo), os encartes da barra de status principal vão estar vazios, mas esses encartes não vão estar vazios.

WindowInsets.navigationBars

Encartes que descrevem as barras de navegação. São as barras da interface do sistema no lado esquerdo, direito ou inferior do dispositivo, que descrevem a barra de tarefas ou os ícones de navegação. Eles podem mudar durante a execução com base no método de navegação preferido do usuário e na interação com a barra de tarefas.

WindowInsets.navigationBarsIgnoringVisibility

Os engastes da barra de navegação quando eles estão visíveis. Se as barras de navegação estiverem ocultas no momento (devido ao entrar no modo de tela cheia imersivo), os encartes da barra de navegação principal vão estar vazios, mas esses encartes não vão estar vazios.

WindowInsets.captionBar

O inseto que descreve a decoração da janela da interface do sistema em uma janela de formato livre, como a barra de título da parte de cima.

WindowInsets.captionBarIgnoringVisibility

Os encartes da barra de legenda para quando estão visíveis. Se as barras de legenda estiverem ocultas, os insetos da barra de legenda principal vão estar vazios, mas não vão estar vazios.

WindowInsets.systemBars

A união dos encartes da barra do sistema, que incluem as barras de status, de navegação e de legenda.

WindowInsets.systemBarsIgnoringVisibility

Os engastes da barra do sistema quando eles estão visíveis. Se as barras de sistema estiverem escondidas no momento (devido ao entrar no modo de tela cheia imersivo), os encartes da barra de sistema principal vão estar vazios, mas esses encartes não vão estar.

WindowInsets.ime

Os insetos descrevem a quantidade de espaço na parte de baixo que o teclado de software ocupa.

WindowInsets.imeAnimationSource

Os encartes que descrevem a quantidade de espaço que o teclado de software ocupava antes da animação do teclado atual.

WindowInsets.imeAnimationTarget

Os encartes que descrevem a quantidade de espaço que o teclado de software vai ocupar após a animação do teclado atual.

WindowInsets.tappableElement

Um tipo de encarte que descreve informações mais detalhadas sobre a interface de navegação, indicando a quantidade de espaço em que os "toques" serão processados pelo sistema, e não pelo app. Para barras de navegação transparentes com navegação por gestos, alguns elementos do app podem ser tocados pela interface de navegação do sistema.

WindowInsets.tappableElementIgnoringVisibility

Os encartes de elemento tocável para quando ficam visíveis. Se os elementos tocáveis estiverem ocultos (devido ao entrar no modo de tela cheia imersivo), os encartes principais do elemento tocável vão estar vazios, mas esses encartes não vão estar.

WindowInsets.systemGestures

Os insets representam a quantidade de insetos em que o sistema vai interceptar gestos para navegação. Os apps podem especificar manualmente o processamento de uma quantidade limitada desses gestos usando Modifier.systemGestureExclusion.

WindowInsets.mandatorySystemGestures

Um subconjunto dos gestos do sistema que sempre serão processados e que não podem ser desativados pelo Modifier.systemGestureExclusion.

WindowInsets.displayCutout

Os insetos representam a quantidade de espaço necessária para evitar a sobreposição com um recorte de tela (entalhe ou orifício).

WindowInsets.waterfall

Os engastes que representam as áreas curvas de uma exibição em cascata. Uma tela em cascata tem áreas curvas ao longo das bordas, onde a tela começa a se curvar nas laterais do dispositivo.

Esses tipos são resumidos em três tipos de encarte que garantem que o conteúdo obscurecidos:

Esses tipos de insetos "seguros" protegem o conteúdo de maneiras diferentes, com base nos insetos da plataforma:

  • Use WindowInsets.safeDrawing para proteger conteúdo que não pode ser desenhado em qualquer IU do sistema. Esse é o uso mais comum de insets: evitar a exibição de conteúdo obscurecido pela interface do sistema (parcial ou completamente).
  • Use WindowInsets.safeGestures para proteger o conteúdo com gestos. Isso evita que os gestos do sistema entrem em conflito com os gestos do aplicativo (como os de baixo folhas, carrosséis ou jogos).
  • Use WindowInsets.safeContent como uma combinação de WindowInsets.safeDrawing e WindowInsets.safeGestures para garantir o conteúdo não tem sobreposição visual e de gestos.

Configuração de encartes

Para permitir que o app tenha controle total sobre onde ele desenha conteúdo, siga estas configurações etapas. Sem essas etapas, o app pode desenhar cores pretas ou sólidas atrás da interface do sistema ou não animar de forma síncrona com o teclado do software.

  1. Segmente o SDK 35 ou mais recente para forçar a tela cheia no Android 15 e versões mais recentes. O app é exibido atrás da interface do sistema. É possível ajustar a interface do seu app lidando encartes.
  2. Opcionalmente, chame enableEdgeToEdge() em Activity.onCreate(), o que permite que o app seja exibido de ponta a ponta em versões anteriores do Android.

  3. Defina android:windowSoftInputMode="adjustResize" nas suas atividades Entrada AndroidManifest.xml. Esta configuração permite que o app receba o tamanho do IME de software como encartes, que podem ser usados para preencher e posicionar o conteúdo quando o IME aparecer e desaparecer do 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 do Compose

Quando a atividade assumir o controle do processamento de todos os encartes, você poderá usar o Compose. APIs para garantir que o conteúdo não seja ofuscado e os elementos interativos não sejam se sobreponham à IU do sistema. Essas APIs também sincronizam o layout do app com alterações de encarte.

Por exemplo, este é o método mais básico de aplicar os insets ao conteúdo de todo o app:

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

    enableEdgeToEdge()

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

Esse snippet aplica os encartes de janela safeDrawing como padding em todo o conteúdo do app. Embora isso garanta que os elementos interativos não se sobreponham à interface do sistema, também significa que nenhum elemento do app será exibido atrás da interface do sistema para alcançar um efeito de borda a borda. Para aproveitar ao máximo você precisa ajustar onde os encartes são aplicados em uma tela, tela por tela. ou componente por componente.

Todos esses tipos de inseto são animados automaticamente com animações de IME reportadas para a API 21. Por extensão, todos os layouts que usam esses insets também são animados automaticamente conforme os valores de inset mudam.

Há duas maneiras principais de usar esses tipos de encarte para ajustar o elemento combinável. Layouts: modificadores de padding e modificadores de tamanho de encarte.

Modificadores de padding

Modifier.windowInsetsPadding(windowInsets: WindowInsets) aplica o encartes de janela fornecidos como padding, agindo da mesma forma que o Modifier.padding faria. Por exemplo, Modifier.windowInsetsPadding(WindowInsets.safeDrawing) se aplica o encarte seguro do desenho como padding nos quatro lados.

Há também vários métodos utilitários integrados para os tipos de inset mais comuns. Modifier.safeDrawingPadding() é um desses métodos, equivalente a Modifier.windowInsetsPadding(WindowInsets.safeDrawing). Há modificadores para os outros tipos de encarte.

Modificadores de tamanho de inserção

Os modificadores a seguir aplicam uma quantidade de engastes de janela definindo o tamanho do componente como o tamanho dos engastes:

Modifier.windowInsetsStartWidth(windowInsets: WindowInsets)

Aplica o lado inicial de windowInsets como a largura (como Modifier.width).

Modifier.windowInsetsEndWidth(windowInsets: WindowInsets)

Aplica o lado final de windowInsets como a largura (como Modifier.width).

Modifier.windowInsetsTopHeight(windowInsets: WindowInsets)

Aplica o lado superior de windowInsets como a altura (como Modifier.height).

Modifier.windowInsetsBottomHeight(windowInsets: WindowInsets)

Aplica o lado inferior de windowInsets como a altura (como Modifier.height).

Esses modificadores são especialmente úteis para dimensionar um Spacer que ocupa de encartes:

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

Consumo de encarte

Os modificadores de padding do encarte (windowInsetsPadding e auxiliares como safeDrawingPadding) consomem automaticamente a parte dos encartes que são aplicado como padding. Ao se aprofundar na árvore de composição, os modificadores de padding anexados e os modificadores de tamanho de inseto sabem que parte dos insetos já foi consumida por modificadores de padding externo e evitam usar a mesma parte dos insetos mais de uma vez, o que resultaria em muito espaço extra.

Os modificadores de tamanho de encartes também evitam usar a mesma parte de encartes mais de uma vez se os encartes já foram consumidos. No entanto, como eles estão mudando o tamanho diretamente, eles não consomem insets.

Como resultado, o aninhamento de modificadores de padding muda automaticamente a quantidade de padding aplicado a cada elemento combinável.

Analisando o mesmo exemplo de LazyColumn anterior, o LazyColumn está sendo redimensionado pelo modificador imePadding. Dentro do LazyColumn, o último item é dimensionado para ser a altura da parte de baixo das barras do sistema:

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

Quando o IME está fechado, o modificador imePadding() não aplica padding, já que o IME não tem altura. Como o modificador imePadding() não está aplicando padding, nenhum encarte será consumido, e a altura do Spacer será o tamanho do na parte de baixo das barras do sistema.

Quando o IME é aberto, os insets são animados para corresponder ao tamanho do IME, e o modificador imePadding() começa a aplicar o padding inferior para redimensionar o LazyColumn conforme o IME é aberto. À medida que o modificador imePadding() começa a aplicar o padding inferior, ele também começa a consumir essa quantidade de insets. Portanto, a A altura do Spacer começa a diminuir, como parte do espaçamento do sistema. barras já foi aplicada pelo modificador imePadding(). Quando o modificador imePadding() aplica um valor de padding inferior maior que as barras do sistema, a altura do Spacer é zero.

Quando o IME é fechado, as alterações acontecem no sentido inverso: o Spacer começa a se expandir a partir de uma altura de zero quando a imePadding() estiver aplicando menos que o na parte de baixo das barras do sistema, até que finalmente a Spacer corresponda à altura na parte inferior das barras do sistema depois que o IME estiver completamente animado.

Figura 2. Coluna lenta de ponta a ponta com TextField.
.

Esse comportamento é alcançado pela comunicação entre todos os modificadores windowInsetsPadding e pode ser influenciado de algumas outras maneiras.

Modifier.consumeWindowInsets(insets: WindowInsets) também consome encartes da mesma forma que Modifier.windowInsetsPadding, mas não aplica os encartes consumidos como padding. Isso é útil junto com o encarte modificadores de tamanho para indicar a irmãos que uma certa quantidade de encartes já foi consumido:

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

O Modifier.consumeWindowInsets(paddingValues: PaddingValues) se comporta muito semelhante à versão com um argumento WindowInsets, mas pega uma PaddingValues arbitrário para consumo. Isso é útil para informar elementos filhos quando o padding ou o espaçamento é fornecido por algum outro mecanismo que não seja os modificadores de padding de inserção, como um Modifier.padding comum ou espaçadores de altura fixa:

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

Nos casos em que os encartes de janela brutos forem necessários sem consumo, use o método WindowInsets diretamente ou use WindowInsets.asPaddingValues() para retornar uma PaddingValues dos encartes que não são afetados pelo consumo. No entanto, devido às ressalvas abaixo, prefira usar o padding de encartes de janela. e encarte de janela sempre que possível.

Encartes e fases do Jetpack Compose

O Compose usa as principais APIs do AndroidX para atualizar e animar encartes, que usam as APIs de plataforma subjacentes para gerenciar encartes. Devido a esse comportamento da plataforma, os insets têm uma relação especial com as fases do Jetpack Compose.

O valor dos insets é atualizado após a fase de composição, mas antes da fase de layout. Isso significa que ler o valor dos encartes na composição geralmente usa um valor dos encartes que está atrasado em um frame. O modelo os modificadores descritos nesta página foram criados para atrasar o uso dos valores do elemento é inserido até a fase de layout, que garante que os valores de encarte sejam usados mesmo frame que são atualizados.

Animações do IME do teclado com WindowInsets

Você pode aplicar Modifier.imeNestedScroll() a um contêiner de rolagem para abrir e feche o IME automaticamente ao rolar para a parte inferior do contêiner.

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

Animação mostrando um elemento da IU rolando para cima e para baixo para dar lugar ao teclado.
Figura 3. Animações do IME.

Suporte a Inset para componentes do Material 3

Para facilitar o uso, muitos dos elementos combináveis integrados do Material 3 (androidx.compose.material3) processam os insetos por conta própria, com base na forma como os elementos combináveis são colocados no app de acordo com as especificações do Material.

Inserção no processamento de elementos combináveis

Confira abaixo uma lista dos componentes do Material Design que processam automaticamente os insets.

Barras de apps

Contêineres de conteúdo

Scaffold

Por padrão, Scaffold fornece insets como parâmetro paddingValues para você consumir e usar. Scaffold não aplica os encartes ao conteúdo. essa responsabilidade é sua. Por exemplo, para consumir esses encartes com um LazyColumn dentro de um 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

Substituir insetos padrão

Você pode mudar o parâmetro windowInsets transmitido ao elemento combinável para configurar o comportamento dele. Esse parâmetro pode ser um tipo diferente de encarte de janela para aplicar ou desativado ao transmitir uma instância vazia: WindowInsets(0, 0, 0, 0):

Por exemplo, para desativar o processamento do encarte em LargeTopAppBar, Defina o parâmetro windowInsets como uma instância vazia:

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

Interoperabilidade com encartes do sistema de visualização

Pode ser necessário substituir os encartes padrão quando a tela tiver visualizações e Escreva o código na mesma hierarquia. Nesse caso, você precisa ser explícito em qual deles deve consumir os encartes e qual deve ignorá-los.

Por exemplo, se o layout mais externo for um layout de visualização do Android, você deverá consumir os encartes no sistema de visualização e ignorá-los no Compose. Como alternativa, se o layout mais externo for um elemento combinável, consuma as incrustações no Compose e adicione os elementos combináveis AndroidView.

Por padrão, cada ComposeView consome todos os encartes no Nível de consumo WindowInsetsCompat. Para alterar esse comportamento padrão, defina ComposeView.consumeWindowInsets para false.

Recursos