Jika Anda menulis kode Compose untuk aplikasi atau membuat library dan API Compose, ikuti praktik terbaik untuk membuat kode Anda dapat diskalakan, berperforma lebih baik, dan konsisten dengan ekosistem lainnya.
Dokumen berikut memberikan panduan bagi siapa pun yang menulis kode yang menggunakan Compose:
- Panduan API untuk Jetpack Compose: Menguraikan pola, praktik
terbaik, dan panduan gaya preskriptif untuk sistem apa pun yang menggunakan plugin dan runtime compiler Jetpack
Compose. Panduan ini mencakup topik berikut:
- Pedoman gaya Kotlin untuk Compose, berdasarkan Konvensi Coding Kotlin
- Panduan untuk fungsi dan API
@Composableyang dibangun 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
@Composabledi Jetpack Compose: Menyediakan serangkaian panduan dan rekomendasi untuk membuat dan menggunakan komponen UI@Composable, termasuk topik berikut:- Membuat dan menyusun komponen
- Memberi nama komponen baru
- Menyatakan dependensi komponen
- Parameter di komponen
@Composable - Mengikuti pola yang benar untuk membuat class dan fungsi terkait komponen
- Mendokumentasikan komponen
@Composable - Meningkatkan aksesibilitas untuk komponen
- Memperbarui API komponen sambil mempertahankan kompatibilitas mundur
Audiens
Panduan ini ditulis untuk tiga audiens berikut:
- Developer yang membangun aplikasi berdasarkan Jetpack Compose. Anda berada dalam grup ini jika Anda menggunakan Jetpack Compose di beberapa bagian aplikasi Anda.
- Developer yang mengerjakan pengembangan framework Jetpack Compose. Anda berada di
grup ini jika Anda memberikan kontribusi ke library
androidx.compose. - Developer yang membuat library berdasarkan Jetpack Compose. Anda berada di grup ini jika Anda membuat API Compose atau library elemen UI Compose. Library komponen Compose ini dapat tersedia secara publik atau lokal untuk perusahaan atau tim Anda.
Bergantung pada grup tempat Anda berada, Anda memiliki tingkat ketat yang berbeda untuk setiap pedoman gaya. Misalnya, pengembangan framework Jetpack Compose umumnya paling ketat mematuhi pedoman ini.
Untuk mengetahui informasi selengkapnya tentang persyaratan untuk setiap audiens developer, lihat RFC2119.
Berkontribusi pada framework dan pedoman
Kami menerima kontribusi untuk library tertentu dalam codebase androidx dan panduan gaya (panduan Compose API dan panduan komponen @Composable).
Untuk berkontribusi, ikuti petunjuk dalam androidxpanduan kontribusi .