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 APIs para Jetpack Compose: Describe patrones, prácticas recomendadas y lineamientos de estilo prescriptivos para cualquier sistema que use el complemento del compilador y el tiempo 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 APIs de
@Composableque se basan en las capacidades del tiempo 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 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
@Composable - Seguir los patrones correctos para crear clases y funciones relacionadas con los componentes
- Documenta los componentes de
@Composable - Mejora de la accesibilidad de los componentes
- Actualización de las APIs de componentes y retención de la retrocompatibilidad
Público
Estos lineamientos se escribieron 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 colaboras con 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 públicamente o ser locales para tu empresa o equipo.
Según el grupo al que pertenezcas, tendrás diferentes niveles de exigencia para cada guía de estilo. Por ejemplo, el desarrollo del framework de Jetpack Compose suele cumplir con mayor rigidez estas instrucciones.
Para obtener más información sobre los requisitos de cada público de desarrolladores, consulta RFC2119.
Colabora con el marco y los lineamientos
Aceptamos contribuciones a bibliotecas seleccionadas en la base de código de androidx y en las guías de estilo (guías de la API de Compose y guías de los componentes de @Composable).
Para colaborar, sigue las instrucciones de la androidx guía de colaboración.