Linee guida di stile per le API Jetpack Compose

Se stai scrivendo codice Compose per la tua app o creando librerie e API Compose, segui le best practice per rendere il tuo codice scalabile, più efficiente e coerente con il resto dell'ecosistema.

I seguenti documenti forniscono linee guida per chiunque scriva codice che utilizza Compose:

  • Linee guida per le API per Jetpack Compose: descrive pattern, best practice e linee guida di stile prescrittive per qualsiasi sistema che utilizza il plug-in del compilatore e il runtime di Jetpack Compose. Include i seguenti argomenti:
    • Linee guida di stile di Kotlin per Compose, basate sulle convenzioni di programmazione di Kotlin
    • Indicazioni per le funzioni e le API @Composable che si basano sulle funzionalità di runtime di Compose
    • Linee guida per le API che utilizzano ed estendono il toolkit per la UI di Compose
    • Pattern per la gestione dei casi d'uso durante la progettazione di un'API Compose
  • Linee guida per le API per i componenti @Composable in Jetpack Compose: fornisce un insieme di linee guida e suggerimenti per la creazione e l'utilizzo dei componenti UI @Composable, inclusi i seguenti argomenti:
    • Creazione e stratificazione dei componenti
    • Assegnare un nome a un nuovo componente
    • Espressione delle dipendenze dei componenti
    • Parametri nei componenti @Composable
    • Seguire i pattern corretti per la creazione di classi e funzioni correlate ai componenti
    • Documentazione dei componenti @Composable
    • Miglioramento dell'accessibilità per i componenti
    • Aggiornamento delle API dei componenti mantenendo la compatibilità con le versioni precedenti

Pubblico

Queste linee guida sono rivolte ai seguenti tre segmenti di pubblico:

  • Sviluppatori che creano app basate su Jetpack Compose. Fai parte di questo gruppo se utilizzi Jetpack Compose in una parte della tua app.
  • Sviluppatori che lavorano allo sviluppo del framework Jetpack Compose. Fai parte di questo gruppo se contribuisci alle librerie androidx.compose.
  • Sviluppatori che creano librerie basate su Jetpack Compose. Fai parte di questo gruppo se crei API Compose o librerie di elementi UI di Compose. Queste librerie di componenti di Compose possono essere disponibili pubblicamente o localmente per la tua azienda o il tuo team.

A seconda del gruppo a cui appartieni, hai diversi livelli di severità per ogni linea guida di stile. Ad esempio, lo sviluppo del framework Jetpack Compose generalmente rispetta più rigorosamente queste linee guida.

Per saperne di più sui requisiti per ogni pubblico di sviluppatori, consulta RFC2119.

Contribuire al framework e alle linee guida

Accettiamo contributi per selezionare le librerie nel codebase androidx e le linee guida di stile (linee guida per l'API Compose e linee guida per i componenti @Composable).

Per contribuire, segui le istruzioni riportate nella guida ai contributi di androidx.