Linee guida di stile per le API Jetpack Compose

Se stai scrivendo codice Compose per la tua app o stai creando 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 API per Jetpack Compose: Outline pattern, best practice e linee guida per lo stile prescrittivo per qualsiasi sistema che utilizza il plug-in e il runtime del compilatore Jetpack Compose. Sono inclusi i seguenti argomenti:
  • Linee guida per lo stile 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 e estendono il toolkit dell'interfaccia utente di 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 dei componenti dell'interfaccia utente @Composable, inclusi i seguenti argomenti:
  • Creazione e applicazione di livelli ai componenti
  • Assegnare un nome a un nuovo componente
  • Esprimere le dipendenze dei componenti
  • Parametri in @Composable componenti
  • Seguire gli schemi corretti per creare funzioni e classi relative 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. Appartendi a questo gruppo se utilizzi Jetpack Compose in una parte della tua app.
• Sviluppatori che lavorano allo sviluppo del framework Jetpack Compose. Sei in questo gruppo se contribuisci alle androidx.compose biblioteche.
• Sviluppatori che creano librerie basate su Jetpack Compose. Sei in questo gruppo se crei API o librerie di elementi dell'interfaccia utente di Compose. Queste librerie dei componenti di Compose potrebbero essere disponibili pubblicamente o a livello locale 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 in genere segue queste linee guida in modo più rigoroso.

Per ulteriori informazioni sui requisiti per ciascun segmento di pubblico di sviluppatori, consulta RFC2119.

Contribuire al framework e alle linee guida

Siamo felici di fornire contributi per selezionare librerie nel codebase androidx e nelle linee guida relative allo stile (linee guida per l'API Compose e linee guida per i componenti di @Composable).

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