Panduan gaya untuk Jetpack Compose API
Tetap teratur dengan koleksi
Simpan dan kategorikan konten berdasarkan preferensi Anda.
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
@Composable
yang 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
@Composable
di 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 androidx
panduan kontribusi .
Konten dan contoh kode di halaman ini tunduk kepada lisensi yang dijelaskan dalam Lisensi Konten. Java dan OpenJDK adalah merek dagang atau merek dagang terdaftar dari Oracle dan/atau afiliasinya.
Terakhir diperbarui pada 2025-09-04 UTC.
[null,null,["Terakhir diperbarui pada 2025-09-04 UTC."],[],[],null,["If you're writing Compose code for your app or building Compose libraries and\nAPIs, follow best practices to make your code scalable, more performant, and\nconsistent with the rest of the ecosystem.\n\nThe following documents provide guidelines for anyone writing code that uses\nCompose:\n\n- [API Guidelines for Jetpack Compose](https://android.googlesource.com/platform/frameworks/support/+/androidx-main/compose/docs/compose-api-guidelines.md): Outlines patterns, best practices, and prescriptive style guidelines for any system using the Jetpack Compose compiler plugin and runtime. It includes the following topics:\n - Kotlin style guidelines for Compose, based on the [Kotlin Coding\n Conventions](https://kotlinlang.org/docs/coding-conventions.html)\n - Guidance for `@Composable` functions and APIs that build on the Compose runtime capabilities\n - Guidelines for APIs that use and extend the Compose UI toolkit\n - Patterns for addressing use cases when designing a Compose API\n- [API Guidelines for `@Composable` components in Jetpack Compose](https://android.googlesource.com/platform/frameworks/support/+/androidx-main/compose/docs/compose-component-api-guidelines.md): Provides a set of guidelines and recommendations for creating and using `@Composable` UI components, including the following topics:\n - Creating and layering components\n - Naming a new component\n - Expressing component dependencies\n - Parameters in `@Composable` components\n - Following correct patterns for creating component-related classes and functions\n - Documenting `@Composable` components\n - Improving accessibility for components\n - Updating component APIs while retaining backwards compatibility\n\nAudience\n\nThese guidelines are written for the following three audiences:\n\n- **Developers building apps based on Jetpack Compose**. You are in this group if you use Jetpack Compose in some part of your app.\n- **Developers working on Jetpack Compose framework development** . You are in this group if you make contributions to the [`androidx.compose` libraries](/jetpack/androidx/releases/compose).\n- **Developers creating libraries based on Jetpack Compose**. You are in this group if you create Compose APIs or libraries of Compose UI elements. These libraries of Compose components may be publicly available or local to your company or team.\n\nDepending on the group you're in, you have different strictness levels for each\nstyle guideline. For example, Jetpack Compose framework development generally\nadheres most strictly to these guidelines.\n\nFor more information about the requirements for each developer audience, see\n[RFC2119](https://www.ietf.org/rfc/rfc2119.txt).\n\nContribute to framework and guidelines\n\nWe welcome contributions to select libraries in the `androidx` codebase and the\nstyle guidelines ([Compose API guidelines](https://android.googlesource.com/platform/frameworks/support/+/androidx-main/compose/docs/compose-api-guidelines.md) and\n[`@Composable` components guidelines](https://android.googlesource.com/platform/frameworks/support/+/androidx-main/compose/docs/compose-component-api-guidelines.md)) themselves.\n\nTo contribute, follow the instructions in the `androidx` [contribution\nguide](https://android.googlesource.com/platform/frameworks/support/+/androidx-main/CONTRIBUTING.md)."]]