Panduan gaya untuk Jetpack Compose API

Jika Anda menulis kode Compose untuk aplikasi atau membuat library dan API Compose, ikuti praktik terbaik untuk membuat kode Anda skalabel, lebih berperforma, dan konsisten dengan ekosistem lainnya.

Dokumen berikut memberikan panduan bagi siapa saja yang menulis kode yang menggunakan Compose:

  • Panduan API untuk Jetpack Compose: Menguraikan pola, praktik terbaik, dan panduan gaya preskriptif untuk semua sistem yang menggunakan plugin dan runtime compiler Jetpack Compose. Topik ini mencakup topik berikut:
    • Panduan gaya Kotlin untuk Compose, berdasarkan Konvensi Coding Kotlin
    • Panduan untuk fungsi dan API @Composable yang di-build berdasarkan kemampuan runtime Compose
    • Panduan untuk API yang menggunakan dan memperluas toolkit UI Compose
    • Pola untuk menangani kasus penggunaan saat mendesain Compose API
  • Panduan API untuk komponen @Composable di Jetpack Compose: Menyediakan serangkaian pedoman dan rekomendasi untuk membuat dan menggunakan komponen UI @Composable, termasuk topik berikut:
    • Membuat dan {i>layering<i} komponen
    • Penamaan komponen baru
    • Mengekspresikan dependensi komponen
    • Parameter di komponen @Composable
    • Mengikuti pola yang benar untuk membuat class dan fungsi terkait komponen
    • Mendokumentasikan komponen @Composable
    • Meningkatkan aksesibilitas komponen
    • Mengupdate API komponen sambil mempertahankan kompatibilitas mundur

Audiens

Pedoman ini ditulis untuk tiga audiens berikut:

  • Developer yang membuat aplikasi berdasarkan Jetpack Compose. Anda berada dalam grup ini jika menggunakan Jetpack Compose di beberapa bagian aplikasi.
  • Developer yang mengerjakan pengembangan framework Jetpack Compose. Anda termasuk dalam grup ini jika memberikan kontribusi ke library androidx.compose.
  • Developer membuat library berdasarkan Jetpack Compose. Anda berada di grup ini jika membuat API Compose atau library elemen UI Compose. Library komponen Compose ini mungkin tersedia secara publik atau bersifat lokal untuk perusahaan atau tim Anda.

Anda memiliki tingkat pengetatan yang berbeda untuk setiap pedoman gaya, bergantung pada grup tempat Anda bergabung. Misalnya, pengembangan framework Jetpack Compose umumnya sangat mematuhi panduan ini.

Untuk mengetahui informasi selengkapnya tentang persyaratan bagi setiap audiens developer, lihat RFC2119.

Berkontribusi pada framework dan panduan

Kami menyambut baik kontribusi pada library tertentu di codebase androidx dan pedoman gaya (pedoman Compose API dan panduan komponen @Composable).

Untuk berkontribusi, ikuti petunjuk dalam panduan kontribusi androidx.