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 à tous ceux qui écrivent du code utilisant 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 compilateur et l'environnement d'exécution 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 et les API @Composable 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 traiter les 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'interface utilisateur @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 modèles appropriés pour créer des classes et des fonctions associées aux 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 audiences suivantes :

• Développeurs créant des applications basées sur Jetpack Compose. Vous appartenez à 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 appartenez à ce groupe si vous contribuez aux androidx.compose bibliothèques.
• Développeurs créant des bibliothèques basées sur Jetpack Compose. Vous appartenez à 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 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 manière plus stricte.

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

Contribuer au framework et aux consignes

Nous acceptons les contributions à certaines bibliothèques de la base de code androidx et aux consignes de style elles-mêmes (consignes relatives aux API Compose et @Composable consignes relatives aux composants).

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