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 que usa 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. Inclui os seguintes tópicos:
    • Diretrizes de estilo do Kotlin para o Compose, com base nas Convenções de codificação do Kotlin
    • Orientação para funções e APIs @Composable que se baseiam nos recursos do 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 @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 sobrepor componentes
    • Como nomear um novo componente
    • Como expressar dependências de componentes
    • Parâmetros em componentes @Composable
    • Como seguir padrões corretos para criar classes e funções relacionadas a componentes
    • Como documentar componentes @Composable
    • Como melhorar a acessibilidade dos componentes
    • Como 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á nesse grupo se usa o Jetpack Compose em alguma parte do seu app.
  • Desenvolvedores que trabalham no desenvolvimento da estrutura do Jetpack Compose. Você está nesse grupo se fizer contribuições para as androidx.compose bibliotecas.
  • Desenvolvedores que criam bibliotecas com base no Jetpack Compose. Você está nesse grupo se criar APIs do Compose ou bibliotecas de elementos de interface do Compose. Essas bibliotecas de componentes do Compose podem estar disponíveis publicamente ou serem 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 da estrutura do Jetpack Compose geralmente adere mais rigorosamente a essas diretrizes.

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

Contribuir para a estrutura e as diretrizes

Aceitamos contribuições para selecionar bibliotecas na base de código androidx e as diretrizes de estilo (diretrizes de API do Compose e @Composable diretrizes de componentes) em si.

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