Panduan gaya untuk Jetpack Compose API

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

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

  • Panduan API untuk Jetpack Compose: Menjelaskan pola, praktik terbaik, dan panduan gaya preskriptif untuk sistem apa pun yang menggunakan plugin compiler dan runtime Jetpack Compose. Panduan ini mencakup topik berikut:
    • Pedoman gaya Kotlin untuk Compose, berdasarkan Konvensi Coding Kotlin
    • Panduan untuk fungsi dan API @Composable yang dibuat 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: Memberikan serangkaian panduan dan rekomendasi untuk membuat dan menggunakan komponen UI @Composable, termasuk topik berikut:
    • Membuat dan menyusun komponen
    • Memberi nama 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 untuk komponen
    • Mengupdate API komponen sekaligus mempertahankan kompatibilitas mundur

Audiens

Panduan ini ditulis untuk tiga audiens berikut:

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

Bergantung pada grup yang Anda ikuti, Anda memiliki tingkat kepatuhan yang berbeda untuk setiap pedoman gaya. Misalnya, pengembangan framework Jetpack Compose umumnya sangat mematuhi pedoman ini.

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

Berkontribusi pada framework dan pedoman

Kami menerima kontribusi untuk memilih library di codebase androidx dan panduan gaya (panduan Compose API dan panduan komponen @Composable) itu sendiri.

Untuk berkontribusi, ikuti petunjuk di panduan kontribusi androidx.