Visualizar a IU com visualizações de composição

Um elemento combinável é definido por uma função e anotado com @Composable:

@Composable
fun SimpleComposable() {
    Text("Hello World")
}
AndroidStudioComposeSnippets.kt

Elemento de texto simples contendo as palavras "Hello World"

Para ativar uma visualização desse elemento, crie outro elemento combinável, com as anotações @Composable e @Preview. Esse novo elemento combinável com anotação agora contém o elemento combinável que você criou inicialmente, SimpleComposable:

@Preview
@Composable
fun SimpleComposablePreview() {
    SimpleComposable()
}
AndroidStudioComposeSnippets.kt

A anotação @Preview informa ao Android Studio que esse elemento combinável precisa ser mostrado na visualização de design desse arquivo. É possível conferir as atualizações em tempo real na visualização combinável enquanto você faz as edições.

GIF mostrando atualizações em tempo real usando a Visualização do Compose

É possível adicionar parâmetros manualmente no código para personalizar a forma como o Android Studio renderiza @Preview. Você pode até adicionar a anotação @Preview à mesma função várias vezes para visualizar um elemento combinável com propriedades diferentes.

Um dos principais benefícios de usar elementos combináveis @Preview é evitar a dependência do emulador no Android Studio. É possível salvar a inicialização de memória pesada do emulador para mais mudanças finais de aparência e a capacidade do @Preview de fazer e testar pequenas mudanças de código com facilidade.

Para aproveitar a anotação @Preview de maneira mais eficaz, defina as telas em termos do estado que ela recebe como entrada e os eventos que ela gera.

Defina seu @Preview

O Android Studio oferece alguns recursos para estender visualizações que podem ser compostas. É possível mudar o design do contêiner, interagir com as visualizações ou fazer a implantação delas diretamente em um emulador ou dispositivo.

Dimensões

Por padrão, as dimensões de @Preview são escolhidas automaticamente para agrupar o conteúdo. Para definir as dimensões manualmente, adicione os parâmetros heightDp e widthDp. Esses valores já são interpretados como dp. Portanto, não é necessário adicionar .dp a eles:

@Preview(widthDp = 50, heightDp = 50)
@Composable
fun SquareComposablePreview() {
    Box(Modifier.background(Color.Yellow)) {
        Text("Hello World")
    }
}
AndroidStudioComposeSnippets.kt

Um quadrado amarelo com as palavras "Hello World"

Prévias de cores dinâmicas

Se você ativou as cores dinâmicas no app, use o atributo wallpaper para trocar de plano de fundo e conferir como a interface reage ao plano de fundo escolhido pelos usuários. Selecione entre os diferentes temas de plano de fundo oferecidos pela classe Wallpaper. Esse recurso requer o Compose 1.4.0 ou mais recente.

Use com diferentes dispositivos

No Android Studio Flamingo, é possível editar o parâmetro device da anotação de visualização para definir configurações para elementos combináveis em diferentes dispositivos.

Exemplo de função combinável

Quando o parâmetro do dispositivo tem uma string vazia (@Preview(device = "")), é possível invocar o preenchimento automático pressionando Ctrl + Space. Em seguida, defina os valores de cada parâmetro.

Como editar a função de exemplo

No preenchimento automático, você pode selecionar qualquer opção de dispositivo da lista, por exemplo, @Preview(device = "id:pixel_4"). Como alternativa, é possível inserir um dispositivo personalizado escolhendo spec:width=px,height=px,dpi=int… para definir os valores individuais de cada parâmetro.

Lista de especificações

Para aplicar, pressione Enter ou cancele com Esc.

Se você definir um valor inválido, a declaração será sublinhada em vermelho, e uma correção poderá estar disponível (Alt + Enter (⌥ + ⏎ no macOS) > Replace with …. A inspeção tenta fornecer uma correção mais próxima da entrada.

Exemplo de valor inválido

Localidade

Para testar diferentes localidades do usuário, adicione o parâmetro locale:

@Preview(locale = "fr-rFR")
@Composable
fun DifferentLocaleComposablePreview() {
    Text(text = stringResource(R.string.greeting))
}
AndroidStudioComposeSnippets.kt

Elemento de texto simples contendo a palavra "Bonjour" com uma bandeira da França

Definir cor do plano de fundo

Por padrão, o elemento combinável é exibido com um plano de fundo transparente. Para adicionar um segundo plano, adicione os parâmetros showBackground e backgroundColor. Lembre-se de que backgroundColor é um Long de ARGB, e não um valor Color:

@Preview(showBackground = true, backgroundColor = 0xFF00FF00)
@Composable
fun WithGreenBackground() {
    Text("Hello World")
}
AndroidStudioComposeSnippets.kt

Um retângulo verde com as palavras "Hello World"

IU do sistema

Caso precise exibir as barras de status e ação em uma visualização, adicione o parâmetro showSystemUi:

@Preview(showSystemUi = true)
@Composable
fun DecoratedComposablePreview() {
    Text("Hello World")
}
AndroidStudioComposeSnippets.kt

Uma janela de visualização mostrando uma atividade com as barras de status e ação.

Modo de interface

O parâmetro uiMode pode usar qualquer uma das constantes Configuration.UI_* e permite que você mude o comportamento da visualização. Por exemplo, você pode definir a visualização para o Modo noturno e ver como o tema reage.

interface da visualização do Compose

LocalInspectionMode

Você pode ler usando o CompositionLocal da propriedade para saber se o elemento combinável está sendo renderizado em uma prévia (dentro de um componente inspecionável).LocalInspectionMode Se a composição for renderizada em uma visualização, o valor de LocalInspectionMode.current será true. Essas informações permitem personalizar a visualização. Por exemplo, é possível mostrar uma imagem de marcador de posição na janela de visualização em vez de dados reais.

Assim, você também pode contornar as limitações. Por exemplo, mostrar dados de amostra em vez de chamar a solicitação de rede.

@Composable
fun GreetingScreen(name: String) {
    if (LocalInspectionMode.current) {
        // Show this text in a preview window:
        Text("Hello preview user!")
    } else {
        // Show this text in the app:
        Text("Hello $name!")
    }
}
AndroidStudioComposeSnippets.kt

Interagir com o @Preview

O Android Studio oferece recursos que permitem interagir com as visualizações definidas. Essa interação ajuda a entender o comportamento de execução das suas prévias e permite navegar melhor na interface com elas.

Modo interativo

O modo interativo permite interagir com uma visualização de forma semelhante a como você faria em um dispositivo que executa seu programa, como um smartphone ou tablet. O modo interativo é isolado em um ambiente de sandbox (ou seja, isolado de outras visualizações), em que é possível clicar em elementos e inserir a entrada do usuário na prévia. É uma forma rápida de testar diferentes estados, gestos e até animações do elemento combinável.

O usuário clicando no botão "interativo" da visualização

Vídeo do usuário interagindo com uma visualização

Navegação de código e contornos de elementos de composição

Passe o cursor sobre uma visualização para ver os contornos dos elementos contidos nela. Clicar em um contorno que pode ser composto aciona a visualização do editor para navegar para a definição.

Usuário passando o cursor sobre uma visualização, fazendo com que o Studio mostre os contornos dos elementos combináveis.

Executar visualização

É possível executar uma @Preview específica em um emulador ou dispositivo físico. A visualização é implantada no mesmo app do projeto como uma nova Activity. Portanto, ela compartilha o mesmo contexto e permissões. Ele não exige que você escreva um código modelo solicitando uma permissão se ela já tiver sido concedida.

Clique no ícone Run Preview Ícone "Executar visualização" ao lado da anotação @Preview ou na parte de cima da visualização. O Android Studio implantará essa @Preview no dispositivo ou emulador conectado.

O usuário clicando no botão "Run preview" (Executar visualização)

Vídeo do usuário implantando uma visualização no dispositivo

Copiar renderização de @Preview

Cada visualização renderizada pode ser copiada no formato de imagem, clicando com o botão direito sobre ela.

O usuário clica em uma visualização para que ela seja copiada como imagem.

Várias visualizações da mesma anotação @Preview

É possível mostrar várias versões do mesmo elemento combinável @Preview com especificações diferentes ou parâmetros diferentes transmitidos para o elemento combinável. Dessa forma, você pode reduzir o código boilerplate que precisaria escrever.

Modelos de várias visualizações

O androidx.compose.ui:ui-tooling-preview 1.6.0-alpha01 e versões mais recentes introduzem modelos da API Multipreview: @PreviewScreenSizes, @PreviewFontScales, @PreviewLightDark e @PreviewDynamicColors, para que, com uma única anotação, você possa visualizar a interface do Compose em cenários comuns.

Visualizar diferentes fontes e tamanhos de tela usando modelos

Criar anotações personalizadas de várias visualizações

Com várias visualizações, é possível definir uma classe de anotação em que há diversas anotações @Preview com configurações diferentes. O uso dessa anotação em uma função combinável renderiza automaticamente todas as diferentes visualizações de uma vez. Por exemplo, é possível usar essa anotação para visualizar vários dispositivos, tamanhos de fonte ou temas ao mesmo tempo, sem precisar repetir essas definições para cada elemento combinável.

Comece criando sua própria classe de anotação personalizada:

@Preview(
    name = "small font",
    group = "font scales",
    fontScale = 0.5f
)
@Preview(
    name = "large font",
    group = "font scales",
    fontScale = 1.5f
)
annotation class FontScalePreviews
AndroidStudioComposeSnippets.kt

Você pode usar essa anotação personalizada para elementos combináveis de visualização:

@FontScalePreviews
@Composable
fun HelloWorldPreview() {
    Text("Hello World")
}
AndroidStudioComposeSnippets.kt

Guia de design do Android Studio mostrando o elemento combinável com fonte pequena e grande

É possível combinar várias anotações de várias visualizações e anotações normais para criar um conjunto mais completo de visualizações. Isso não significa que todas as combinações diferentes serão mostradas. Na verdade, cada anotação de várias visualizações funciona de maneira independente e renderiza apenas as próprias variantes.

@Preview(
    name = "Spanish",
    group = "locale",
    locale = "es"
)
@FontScalePreviews
annotation class CombinedPreviews

@CombinedPreviews
@Composable
fun HelloWorldPreview2() {
    MaterialTheme { Surface { Text(stringResource(R.string.hello_world)) } }
}
AndroidStudioComposeSnippets.kt

Guia de design do Android Studio mostrando o elemento combinável em todas as configurações

A natureza de mistura e combinação da visualização múltipla e da visualização normal permite testar de forma mais abrangente muitas propriedades de projetos de maior escala.

@Preview e grandes conjuntos de dados

Muitas vezes, é necessário transmitir um grande conjunto de dados para a visualização combinável. Para fazer isso, basta transmitir dados de amostra para uma função de visualização combinável adicionando um parâmetro com a anotação @PreviewParameter.

@Preview
@Composable
fun UserProfilePreview(
    @PreviewParameter(UserPreviewParameterProvider::class) user: User
) {
    UserProfile(user)
}

AndroidStudioComposeSnippets.kt

Para fornecer os dados de amostra, crie uma classe que implemente o PreviewParameterProvider e retorne os dados de exemplo como uma sequência.

class UserPreviewParameterProvider : PreviewParameterProvider<User> {
    override val values = sequenceOf(
        User("Elise"),
        User("Frank"),
        User("Julia")
    )
}
AndroidStudioComposeSnippets.kt

Isso renderiza uma visualização por elemento de dados na sequência:

Prévias mostrando elementos combináveis de Elise, Frank e Julia

Você pode usar a mesma classe de provedor para várias visualizações. Se necessário, limite o número de visualizações definindo o parâmetro "limit".

@Preview
@Composable
fun UserProfilePreview2(
    @PreviewParameter(UserPreviewParameterProvider::class, limit = 2) user: User
) {
    UserProfile(user)
}
AndroidStudioComposeSnippets.kt

Limitações e práticas recomendadas

O Android Studio executa o código de visualização diretamente na área de visualização. Ele não exige a execução de um emulador ou dispositivo físico porque aproveita uma parte portada do framework do Android chamada Layoutlib. Layoutlib é uma versão personalizada do framework Android projetada para ser executada fora dos dispositivos Android. O objetivo da biblioteca é fornecer uma visualização de um layout no Android Studio que seja muito próxima da renderização em dispositivos.

Limitações de visualização

Devido à forma como as prévias são renderizadas no Android Studio, elas são leves e não exigem todo o framework do Android para renderização. No entanto, isso tem as seguintes limitações:

  • Não há acesso à rede
  • Não há acesso ao arquivo
  • Algumas APIs de Context podem não estar totalmente disponíveis

Visualizações e ViewModels

As visualizações são limitadas ao usar ViewModel em um elemento combinável. O sistema de visualização não é capaz de construir todos os parâmetros transmitidos para um ViewModel, como repositórios, casos de uso, gerenciadores ou similares. Além disso, se a ViewModel participar da injeção de dependência (como com o Hilt), o sistema de visualização não poderá criar o gráfico de dependência inteiro para criar a ViewModel.

Quando você tenta visualizar um elemento combinável com ViewModel, o Android Studio mostra um erro ao renderizar o elemento combinável específico:

Painel de problemas do Android Studio com a mensagem &quot;Failed to instantiate a &quot;ViewModel&quot;

Se você quiser conferir um elemento combinável que usa um ViewModel, crie outro combinável com os parâmetros de ViewModel transmitidos como argumentos do elemento combinável. Dessa forma, não é necessário visualizar o elemento combinável que usa o ViewModel.

@Composable
fun AuthorColumn(viewModel: AuthorViewModel = viewModel()) {
  AuthorColumn(
    name = viewModel.authorName,
    // ViewModel sends the network requests and makes posts available as a state
    posts = viewModel.posts
  )
}

@Preview
@Composable
fun AuthorScreenPreview(
  // You can use some sample data to preview your composable without the need to construct the ViewModel
  name: String = sampleAuthor.name,
  posts: List<Post> = samplePosts[sampleAuthor]
) {
  AuthorColumn(...) {
    name = NameLabel(name),
    posts = PostsList(posts)
  }
}

Classe de anotação @Preview

Você pode pressionar Ctrl ou ⌘ + clicar na anotação @Preview no Android Studio para conferir uma lista completa de parâmetros que podem ser ajustados ao personalizar a visualização.

annotation class Preview(
    val name: String = "",
    val group: String = "",
    @IntRange(from = 1) val apiLevel: Int = -1,
    val widthDp: Int = -1,
    val heightDp: Int = -1,
    val locale: String = "",
    @FloatRange(from = 0.01) val fontScale: Float = 1f,
    val showSystemUi: Boolean = false,
    val showBackground: Boolean = false,
    val backgroundColor: Long = 0,
    @UiMode val uiMode: Int = 0,
    @Device val device: String = Devices.DEFAULT,
    @Wallpaper val wallpaper: Int = Wallpapers.NONE,
)
AndroidStudioComposeSnippets.kt

Outros recursos

Para saber mais sobre como o Android Studio promove a facilidade de uso do @Preview e aprender mais dicas de ferramentas, confira o blog Ferramentas do Compose.

Próxima
Visualizar e depurar animações