Linee guida di stile per le API Jetpack Compose

Se scrivi codice Compose per la tua app o crei librerie e API Compose, segui le best practice per rendere il codice scalabile, più performante 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: descrivono pattern, best practice e linee guida di stile prescrittive per qualsiasi sistema che utilizzi il plug-in del compilatore e il runtime di Jetpack Compose. Include i seguenti argomenti:
    • Linee guida di stile Kotlin per Compose, basate sulle convenzioni di codifica Kotlin
    • Indicazioni per le funzioni e le API @Composable che si basano sulle funzionalità del runtime di Compose
    • Linee guida per le API che utilizzano ed estendono il toolkit UI Compose
    • Pattern per gestire i casi d'uso durante la progettazione di un'API Compose
  • Linee guida per le API per i componenti @Composable in Jetpack Compose: Fornisce una serie di linee guida e consigli per la creazione e l'utilizzo di componenti UI @Composable, inclusi i seguenti argomenti:
    • Creare e sovrapporre componenti
    • Assegnare un nome a un nuovo componente
    • Esprimere le dipendenze dei componenti
    • Parametri nei componenti @Composable
    • Seguendo 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 scritte per i 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 dell'interfaccia utente di Compose. Queste librerie di componenti 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 rigore per ogni linea guida di stile. Ad esempio, lo sviluppo del framework Jetpack Compose in genere 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 a librerie selezionate nel codebase androidx e nelle 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 per i contributi.androidx