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 orientações 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
@Composableque 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 do Compose
- Diretrizes de 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 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
- Documentação de componentes
@Composable - Melhorar a acessibilidade de componentes
- Como atualizar APIs de componentes e manter 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á neste grupo se usa o Jetpack Compose em alguma parte do app.
- Desenvolvedores que trabalham no desenvolvimento do framework 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 ou bibliotecas de elementos de interface do Compose. Essas bibliotecas de componentes do Compose podem estar disponíveis publicamente ou localmente para sua empresa ou equipe.
Dependendo do grupo em que você está, você tem níveis de rigor diferentes 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.