Lineamientos de estilo para las APIs de Jetpack Compose
Organiza tus páginas con colecciones
Guarda y categoriza el contenido según tus preferencias.
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
@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 los componentes de
@Composable
en 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 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 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 contribuir, sigue las instrucciones de la guía de contribuciones de androidx
.
El contenido y las muestras de código que aparecen en esta página están sujetas a las licencias que se describen en la Licencia de Contenido. Java y OpenJDK son marcas registradas de Oracle o sus afiliados.
Última actualización: 2025-09-04 (UTC)
[null,null,["Última actualización: 2025-09-04 (UTC)"],[],[],null,["If you're writing Compose code for your app or building Compose libraries and\nAPIs, follow best practices to make your code scalable, more performant, and\nconsistent with the rest of the ecosystem.\n\nThe following documents provide guidelines for anyone writing code that uses\nCompose:\n\n- [API Guidelines for Jetpack Compose](https://android.googlesource.com/platform/frameworks/support/+/androidx-main/compose/docs/compose-api-guidelines.md): Outlines patterns, best practices, and prescriptive style guidelines for any system using the Jetpack Compose compiler plugin and runtime. It includes the following topics:\n - Kotlin style guidelines for Compose, based on the [Kotlin Coding\n Conventions](https://kotlinlang.org/docs/coding-conventions.html)\n - Guidance for `@Composable` functions and APIs that build on the Compose runtime capabilities\n - Guidelines for APIs that use and extend the Compose UI toolkit\n - Patterns for addressing use cases when designing a Compose API\n- [API Guidelines for `@Composable` components in Jetpack Compose](https://android.googlesource.com/platform/frameworks/support/+/androidx-main/compose/docs/compose-component-api-guidelines.md): Provides a set of guidelines and recommendations for creating and using `@Composable` UI components, including the following topics:\n - Creating and layering components\n - Naming a new component\n - Expressing component dependencies\n - Parameters in `@Composable` components\n - Following correct patterns for creating component-related classes and functions\n - Documenting `@Composable` components\n - Improving accessibility for components\n - Updating component APIs while retaining backwards compatibility\n\nAudience\n\nThese guidelines are written for the following three audiences:\n\n- **Developers building apps based on Jetpack Compose**. You are in this group if you use Jetpack Compose in some part of your app.\n- **Developers working on Jetpack Compose framework development** . You are in this group if you make contributions to the [`androidx.compose` libraries](/jetpack/androidx/releases/compose).\n- **Developers creating libraries based on Jetpack Compose**. You are in this group if you create Compose APIs or libraries of Compose UI elements. These libraries of Compose components may be publicly available or local to your company or team.\n\nDepending on the group you're in, you have different strictness levels for each\nstyle guideline. For example, Jetpack Compose framework development generally\nadheres most strictly to these guidelines.\n\nFor more information about the requirements for each developer audience, see\n[RFC2119](https://www.ietf.org/rfc/rfc2119.txt).\n\nContribute to framework and guidelines\n\nWe welcome contributions to select libraries in the `androidx` codebase and the\nstyle guidelines ([Compose API guidelines](https://android.googlesource.com/platform/frameworks/support/+/androidx-main/compose/docs/compose-api-guidelines.md) and\n[`@Composable` components guidelines](https://android.googlesource.com/platform/frameworks/support/+/androidx-main/compose/docs/compose-component-api-guidelines.md)) themselves.\n\nTo contribute, follow the instructions in the `androidx` [contribution\nguide](https://android.googlesource.com/platform/frameworks/support/+/androidx-main/CONTRIBUTING.md)."]]