Si escribes código de Compose para tu app o compilas bibliotecas y APIs de Compose, sigue las prácticas recomendadas para que tu código sea escalable, más eficiente y coherente con el resto del ecosistema.
En los siguientes documentos, se proporcionan lineamientos para cualquier persona que escriba código que use Compose:
- Lineamientos de la API para Jetpack Compose: Describe los patrones, las prácticas recomendadas y los lineamientos de estilo prescriptivos para cualquier sistema que use el complemento y el entorno de ejecución del compilador de Jetpack Compose. Incluye los siguientes temas:
- Lineamientos de estilo de Kotlin para Compose, basados en las Convenciones de programación de Kotlin
- Orientación para las funciones y las APIs de
@Composableque se basan en las capacidades del entorno de ejecución de Compose - Lineamientos para las APIs que usan y extienden el kit de herramientas de la IU de Compose
- Patrones para abordar casos de uso cuando se diseña una API de Compose
- Lineamientos de APIs para componentes
@Composableen Jetpack Compose: Proporciona un conjunto de lineamientos y recomendaciones para crear y usar componentes de IU de@Composable, incluidos los siguientes temas:- Cómo crear y aplicar capas de componentes
- Cómo asignar un nombre a un componente nuevo
- Cómo expresar dependencias de componentes
- Parámetros en componentes
@Composable - Seguir los patrones correctos para crear clases y funciones relacionadas con los componentes
- Documentación de los componentes de
@Composable - Mejora de la accesibilidad de los componentes
- Cómo actualizar las APIs de componentes y conservar la retrocompatibilidad
Público
Estos lineamientos están escritos para los siguientes tres públicos:
- Desarrolladores que compilan apps basadas en Jetpack Compose Perteneces a este grupo si usas Jetpack Compose en alguna parte de tu app.
- Desarrolladores que trabajan en el desarrollo del framework de Jetpack Compose. Perteneces a este grupo si realizas contribuciones a las bibliotecas de
androidx.compose. - Desarrolladores que crean bibliotecas basadas en Jetpack Compose. Perteneces a este grupo si creas APIs o bibliotecas de elementos de la IU de Compose. Estas bibliotecas de componentes de Compose pueden estar disponibles para el público o ser locales para tu empresa o equipo.
Según el grupo en el que te encuentres, tendrás diferentes niveles de rigurosidad para cada lineamiento de diseño. Por ejemplo, el desarrollo del framework de Jetpack Compose suele cumplir de manera más estricta con estos lineamientos.
Para obtener más información sobre los requisitos para cada público de desarrolladores, consulta RFC2119.
Contribuir con el framework y los lineamientos
Aceptamos las contribuciones a bibliotecas seleccionadas de la base de código androidx y los lineamientos de estilo (lineamientos de la API de Compose y lineamientos de componentes @Composable).
Para contribuir, sigue las instrucciones de la guía de contribuciones de androidx.