Diretrizes de estilo para APIs do Jetpack Compose

Se você estiver escrevendo código do Compose para seu app ou criando bibliotecas e APIs do Compose, siga as práticas recomendadas para tornar seu código escalonável, mais eficiente e consistente com o restante do ecossistema.

Os documentos a seguir fornecem diretrizes para quem escreve código usando Compose:

  • Diretrizes de API para o Jetpack Compose: descreve padrões, práticas recomendadas e diretrizes de estilo prescritivas para qualquer sistema que use o plug-in do compilador e o tempo de execução do Jetpack Compose. Ele inclui os seguintes tópicos:
    • Diretrizes de estilo do Kotlin para o Compose, com base nas Convenções de programação do Kotlin
    • Orientações para funções e APIs @Composable que usam os recursos de tempo de execução do Compose
    • Diretrizes para APIs que usam e estendem o kit de ferramentas de interface do Compose
    • Padrões para abordar casos de uso ao projetar uma API do Compose
  • Diretrizes de API para componentes @Composable no Jetpack Compose: fornece um conjunto de diretrizes e recomendações para criar e usar componentes de interface @Composable, incluindo os seguintes tópicos:
    • Como criar e organizar componentes em camadas
    • Como nomear um novo componente
    • Como expressar dependências de componentes
    • Parâmetros em componentes @Composable
    • Seguir padrões corretos para criar classes e funções relacionadas a componentes
    • Documentar componentes @Composable
    • Melhorar a acessibilidade dos componentes
    • Atualizar APIs de componentes mantendo a compatibilidade com versões anteriores

Público-alvo

Estas diretrizes foram escritas para os três públicos a seguir:

  • Desenvolvedores que criam apps com base no Jetpack Compose. Você está neste grupo se usa o Jetpack Compose em alguma parte do seu app.
  • Desenvolvedores que trabalham no desenvolvimento da estrutura do Jetpack Compose. Você está neste grupo se fizer contribuições para as bibliotecas androidx.compose.
  • Desenvolvedores que criam bibliotecas com base no Jetpack Compose. Você está neste grupo se criar APIs do Compose ou bibliotecas de elementos da interface do Compose. Essas bibliotecas de componentes do Compose podem estar disponíveis publicamente ou ser locais para sua empresa ou equipe.

Dependendo do grupo em que você está, há diferentes níveis de rigor para cada diretriz de estilo. Por exemplo, o desenvolvimento do framework Jetpack Compose geralmente segue essas diretrizes de forma mais estrita.

Para mais informações sobre os requisitos de cada público-alvo de desenvolvedores, consulte RFC2119.

Contribuir com frameworks e diretrizes

Aceitamos contribuições para bibliotecas selecionadas na base de código androidx e nas diretrizes de estilo (diretrizes da API Compose e diretrizes de componentes do @Composable).

Para contribuir, siga as instruções no androidx guia de contribuição.