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 resto do ecossistema.

Os documentos a seguir fornecem diretrizes para qualquer pessoa que esteja escrevendo código que use 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. Ela 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 @Composable que usam os recursos 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 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:
    • Criar e organizar componentes
    • 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
    • Como documentar os componentes @Composable
    • Melhorar a acessibilidade de componentes
    • Atualizar APIs de componentes sem perder a compatibilidade com versões anteriores

Público-alvo

Estas diretrizes foram criadas para os seguintes três públicos:

  • Desenvolvedores que criam apps com base no Jetpack Compose. Você está nesse grupo se usa o Jetpack Compose em alguma parte do app.
  • Desenvolvedores trabalhando no desenvolvimento do framework 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ê vai fazer parte desse 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 ser locais para sua empresa ou equipe.

Dependendo do grupo de que você faz parte, você terá diferentes níveis de rigidez para cada diretriz de estilo. Por exemplo, o desenvolvimento de 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 desenvolvedor, consulte RFC2119.

Contribuir com o framework e as diretrizes

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

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