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 oferecem 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. Ele inclui os seguintes tópicos:
- Diretrizes de estilo do Kotlin para o Compose, baseadas nas Convenções de codificação do Kotlin (link em inglês).
- Orientação para funções
@Composablee APIs criadas com base nos 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 da API para componentes
@Composableno 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 aplicar camadas de componentes
- 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 componentes
@Composable - Como melhorar a acessibilidade dos componentes
- Atualizar APIs de componentes mantendo a compatibilidade com versões anteriores
Público
Essas diretrizes foram elaboradas para os três públicos a seguir:
- Desenvolvedores de apps baseados no Jetpack Compose. Você estará nesse grupo se usar o Jetpack Compose em alguma parte do app.
- Desenvolvedores que trabalham no desenvolvimento do framework do Jetpack Compose. Você estará
nesse grupo se fizer contribuições para as bibliotecas
androidx.compose. - Desenvolvedores que criam bibliotecas baseadas no Jetpack Compose. Você faz parte desse grupo se cria APIs ou bibliotecas do Compose de elementos de interface do Compose. Essas bibliotecas de componentes do Compose podem estar disponíveis publicamente ou locais para sua empresa ou equipe.
Dependendo do grupo em que você está, você tem diferentes níveis de rigidez para cada diretriz de estilo. Por exemplo, o desenvolvimento do framework do Jetpack Compose geralmente segue mais estritamente a essas diretrizes.
Para mais informações sobre os requisitos de cada público-alvo de desenvolvedor, consulte a RFC2119 (link em inglês).
Contribuir com a estrutura e as diretrizes
Aceitamos contribuições para selecionar bibliotecas na base de código androidx e para as
próprias diretrizes de estilo (diretrizes da API Compose e
@Composable).
Para contribuir, siga as instruções no guia de contribuição do androidx.