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, plus performant et cohérent avec le reste de l'écosystème.
Les documents suivants fournissent des consignes à toute personne écrivant du code qui utilise Compose:
- Consignes relatives aux API pour Jetpack Compose: décrit les modèles, les bonnes pratiques et les consignes de style prescriptives pour tout système utilisant le plug-in de compilation et l'environnement d'exécution Jetpack Compose. Il comprend 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'outils 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'UI@Composable, y compris les sujets suivants :- Créer des composants et les superposer
- Nommer un nouveau composant
- Exprimer les dépendances des composants
- Paramètres des composants
@Composable - Suivre les modèles appropriés pour créer des classes et des fonctions liées aux composants
- Documenter les composants
@Composable - Améliorer l'accessibilité des composants
- Mettre à jour les API de composants tout en conservant la rétrocompatibilité
Audience
Ces consignes sont destinées aux trois audiences suivantes:
- Les 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 contribuez aux bibliothèques
androidx.compose. - Développeurs qui créent des bibliothèques basées sur Jetpack Compose Vous faites partie de ce groupe si vous créez des API ou des bibliothèques Compose d'éléments d'interface utilisateur Compose. Ces bibliothèques de composants Compose peuvent être disponibles publiquement ou locales pour votre entreprise ou votre équipe.
Selon le groupe auquel vous appartenez, vous disposez de niveaux de sévérité différents pour chaque consigne de style. Par exemple, le développement du framework Jetpack Compose respecte généralement de manière très stricte ces consignes.
Pour en savoir plus sur les exigences concernant chaque audience de développeur, consultez la RFC 2119.
Contribuer au framework et aux consignes
Nous acceptons les contributions pour sélectionner des bibliothèques dans le codebase androidx et les consignes de style (Consignes relatives à l'API Compose et Consignes relatives aux composants @Composable) elles-mêmes.
Pour contribuer, suivez les instructions du guide de contribution androidx.