Si escribes código de Compose para tu app o compilas bibliotecas y APIs de Compose, sigue las prácticas recomendadas para hacer que tu código sea escalable, tenga más 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 y el tiempo de ejecución del complemento de compilador 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 API para 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 y superponer componentes
- Cómo nombrar 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
- Cómo documentar los componentes de
@Composable - Cómo mejorar la accesibilidad de los componentes
- Cómo actualizar las APIs de componentes sin perder la retrocompatibilidad
Público
Estos lineamientos están dirigidos a los siguientes tres públicos:
- Desarrolladores que compilan apps basadas en Jetpack Compose. Llegarás a este grupo si usas Jetpack Compose en alguna parte de tu app.
- Desarrolladores que trabajan en el desarrollo del framework de Jetpack Compose. Participarás en este grupo si realizas contribuciones a las bibliotecas
androidx.compose. - Desarrolladores que crean bibliotecas basadas en Jetpack Compose Estás en este grupo si creas APIs o bibliotecas de Compose de elementos de la IU de Compose. Estas bibliotecas de componentes de Compose pueden estar disponibles públicamente o ser locales para tu empresa o equipo.
Según el grupo en el que estés, tendrás diferentes niveles de rigurosidad para cada lineamiento de estilo. Por ejemplo, el desarrollo del framework de Jetpack Compose suele cumplir de manera más estricta con estos lineamientos.
Si deseas obtener más información sobre los requisitos para cada público de desarrolladores, consulta RFC2119.
Contribuye con el marco de trabajo y los lineamientos
Aceptamos las contribuciones para algunas bibliotecas en la base de código androidx y los lineamientos de estilo (lineamientos de la API de Compose y lineamientos de componentes de @Composable).
Si quieres contribuir, sigue las instrucciones que se indican en la guía de contribución de androidx.