Si vous écrivez du code Compose pour votre application ou si vous créez des bibliothèques et des API Compose, suivez les bonnes pratiques pour rendre votre code évolutif, performant et cohérent avec le reste de l'écosystème.
Les documents suivants fournissent des instructions à toute personne écrivant du code avec Compose:
- Consignes relatives aux API pour Jetpack Compose: décrit les modèles, les bonnes pratiques et les consignes de style normatives pour tout système à l'aide du plug-in et de l'environnement d'exécution du compilateur Jetpack Compose. Il aborde les sujets suivants :
- Consignes de style Kotlin pour Compose, basées sur les conventions de codage Kotlin
- Conseils pour les fonctions
@Composableet les API qui s'appuient sur les fonctionnalités d'exécution de Compose. - Consignes pour les API qui utilisent et étendent le kit d'interface utilisateur Compose
- Modèles pour répondre aux cas d'utilisation lors de la conception d'une API Compose
- Consignes relatives aux API pour les composants
@Composabledans Jetpack Compose : fournit un ensemble de consignes et de recommandations pour créer et utiliser des composants d'interface utilisateur@Composable, y compris sur les sujets suivants :- Créer et superposer des composants
- Nommer un nouveau composant
- Exprimer les dépendances des composants
- Paramètres des composants
@Composable - Suivre les modèles corrects pour créer des classes et des fonctions associées à des composants
- Documenter les composants
@Composable - Améliorer l'accessibilité des composants
- Mettre à jour les API des composants tout en conservant la rétrocompatibilité
Audience
Ces consignes sont destinées aux trois publics suivants:
- Développeurs qui créent des applications basées sur Jetpack Compose. Vous êtes dans ce groupe si vous utilisez Jetpack Compose dans une partie de votre application.
- Développeurs travaillant sur le développement du framework Jetpack Compose. Vous faites partie de ce groupe si vous apportez des contributions aux bibliothèques
androidx.compose. - Développeurs créant des bibliothèques basées sur Jetpack Compose. Vous faites partie de ce groupe si vous créez des API Compose ou des bibliothèques d'éléments d'interface utilisateur Compose. Ces bibliothèques de composants Compose peuvent être accessibles au public ou être locales dans votre entreprise ou votre équipe.
Selon le groupe dont vous faites partie, vous disposez de différents niveaux de sévérité pour chaque consigne de style. Par exemple, le développement du framework Jetpack Compose respecte généralement ces consignes.
Pour en savoir plus sur les exigences de chaque audience de développeurs, consultez le document RFC2119.
Contribuer au cadre et aux consignes
Nous acceptons les contributions à certaines bibliothèques dans le codebase androidx ainsi que les consignes de style (consignes de l'API Compose et consignes relatives aux composants @Composable).
Pour contribuer, suivez les instructions du guide de contribution androidx.