Lineamientos de estilo para las APIs de Jetpack Compose

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.

Los siguientes documentos 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 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 @Composable que 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 componentes @Composable en Jetpack Compose: Proporciona un conjunto de lineamientos y recomendaciones para crear y usar componentes de la IU @Composable, incluidos los siguientes temas:
    • Creación y superposición de componentes
    • Cómo nombrar un componente nuevo
    • Cómo expresar dependencias de componentes
    • Parámetros en componentes @Composable
    • Cómo seguir patrones correctos para crear clases y funciones relacionadas con componentes
    • Cómo documentar componentes @Composable
    • Cómo mejorar 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. 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. Estás en este grupo si haces contribuciones a las androidx.compose bibliotecas.
  • Desarrolladores que crean bibliotecas basadas en Jetpack Compose. Estás en 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 rigidez para cada lineamiento de estilo. Por ejemplo, el desarrollo del framework de Jetpack Compose suele adherirse de forma más estricta a estos lineamientos.

Para obtener más información sobre los requisitos de cada público de desarrolladores, consulta RFC2119.

Contribuye al framework y a los lineamientos

Agradecemos las contribuciones a las bibliotecas seleccionadas en la base de código androidx y a los lineamientos de estilo (lineamientos de la API de Compose y @Composable lineamientos de componentes) mismos.

Para contribuir, sigue las instrucciones de la androidx guía de contribución.