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, tenga un mejor rendimiento y sea 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 patrones, prácticas recomendadas y lineamientos de estilo prescriptivos para cualquier sistema que use el complemento del compilador y el entorno de ejecución de Jetpack Compose. Incluye los siguientes temas:
- Lineamientos de estilo de Kotlin para Compose, basados en las convenciones de codificació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 la API para los componentes de
@Composableen Jetpack Compose: Proporciona un conjunto de lineamientos y recomendaciones para crear y usar componentes de la IU de@Composable, incluidos los siguientes temas:- Cómo crear componentes y organizarlos en capas
- Asigna un nombre a un componente nuevo
- Cómo expresar dependencias de componentes
- Parámetros en componentes de
@Composable - Seguir los patrones correctos para crear clases y funciones relacionadas con los componentes
- Documentación de los componentes de
@Composable - Mejora la accesibilidad de los componentes
- Actualiza las APIs de componentes y conserva la retrocompatibilidad
Público
Estos lineamientos se escribieron para los siguientes tres públicos:
- Desarrolladores que crean apps basadas en Jetpack Compose Estás en este grupo si usas Jetpack Compose en alguna parte de tu app.
- Desarrolladores que trabajan en el desarrollo del framework de Jetpack Compose Formas parte de 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 de Compose o bibliotecas de elementos de la IU de Compose. Estas bibliotecas de componentes de Compose pueden estar disponibles de forma pública o local para tu empresa o equipo.
Según el grupo en el que te encuentres, tendrás diferentes niveles de rigurosidad para cada lineamiento de estilo. Por ejemplo, el desarrollo del framework de Jetpack Compose suele cumplir con estos lineamientos de forma más estricta.
Para obtener más información sobre los requisitos de cada público de desarrolladores, consulta RFC2119.
Contribuye al marco de trabajo y los lineamientos
Aceptamos contribuciones para seleccionar bibliotecas en la base de código de androidx y los lineamientos de estilo (Lineamientos de la API de Compose y lineamientos de los componentes de @Composable).
Para contribuir, sigue las instrucciones de la guía de contribución de androidx.