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ódigos que usam o 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 ambiente 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 (link em inglês)
    • Orientações para funções e APIs do @Composable que se baseiam nos recursos de ambiente 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 do @Composable no Jetpack Compose: oferece um conjunto de diretrizes e recomendações para criar e usar componentes de interface do @Composable, incluindo os seguintes tópicos:
    • Como criar e organizar componentes em camadas
    • Nomear um novo componente
    • Como expressar dependências de componentes
    • Parâmetros em componentes @Composable
    • Seguir os padrões corretos para criar classes e funções relacionadas a componentes
    • Como documentar componentes do @Composable
    • Melhorar a acessibilidade dos componentes
    • Atualização de APIs de componentes sem perder a compatibilidade com versões anteriores

Público-alvo

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

  • Desenvolvedores que criam apps com base no Jetpack Compose. Você está nesse grupo se usa o Jetpack Compose em alguma parte do app.
  • Desenvolvedores que trabalham no desenvolvimento do framework do Jetpack Compose. Você faz parte desse grupo se contribui para as bibliotecas do androidx.compose.
  • Desenvolvedores que criam bibliotecas com base no Jetpack Compose. Você estará nesse 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 do Jetpack Compose geralmente segue essas diretrizes de forma mais rigorosa.

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

Contribuir para o framework e as diretrizes

Aceitamos contribuições para selecionar bibliotecas 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.