Consignes de style pour les API Jetpack Compose

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 pour 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'exécution Jetpack Compose. Voici quelques-uns des thèmes abordés :
    • Consignes de style Kotlin pour Compose, basées sur les conventions de codage Kotlin
    • Conseils pour les fonctions et les API @Composable qui s'appuient sur les capacités du runtime Compose
    • Consignes pour les API qui utilisent et étendent le kit d'outils Compose UI
    • Modèles pour répondre aux cas d'utilisation lors de la conception d'une API Compose
  • Consignes relatives aux API pour les composants @Composable dans 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 et superposer des composants
    • Nommer un nouveau composant
    • Exprimer les dépendances des composants
    • Paramètres dans les composants @Composable
    • Suivre les bons modèles 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 s'adressent aux trois publics suivants :

  • Développeurs créant des applications basées sur Jetpack Compose. Vous faites partie de 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 Compose ou des bibliothèques d'éléments d'interface utilisateur Compose. Ces bibliothèques de composants Compose peuvent être publiques ou locales à votre entreprise ou équipe.

Selon le groupe auquel vous appartenez, vous disposez de différents niveaux de rigueur pour chaque consigne de style. Par exemple, le développement du framework Jetpack Compose respecte généralement ces consignes de la manière la plus stricte.

Pour en savoir plus sur les exigences pour chaque audience de développeurs, consultez la RFC2119.

Contribuer au framework et aux consignes

Nous acceptons les contributions à certaines bibliothèques du codebase androidx et aux consignes de style (Consignes de l'API Compose et Consignes des composants @Composable) elles-mêmes.

Pour contribuer, suivez les instructions du guide de contribution androidx.