Stilrichtlinien für Jetpack Compose APIs
Mit Sammlungen den Überblick behalten
Sie können Inhalte basierend auf Ihren Einstellungen speichern und kategorisieren.
Wenn Sie Compose-Code für Ihre App schreiben oder Compose-Bibliotheken und APIs erstellen, sollten Sie Best Practices befolgen, damit Ihr Code skalierbar, leistungsfähiger und mit dem Rest des Ökosystems kompatibel ist.
Die folgenden Dokumente enthalten Richtlinien für alle, die Code schreiben, in dem Compose verwendet wird:
- API-Richtlinien für Jetpack Compose: Hier werden Muster, Best Practices und verbindliche Stilrichtlinien für jedes System beschrieben, das das Jetpack Compose-Compiler-Plug-in und die Laufzeit verwendet. Dazu gehören die folgenden Themen:
- Kotlin-Stilrichtlinien für Compose, basierend auf den Kotlin-Programmierkonventionen
- Anleitung für
@Composable-Funktionen und APIs, die auf den Compose-Laufzeitfunktionen basieren
- Richtlinien für APIs, die das Compose-UI-Toolkit verwenden und erweitern
- Muster für die Behandlung von Anwendungsfällen beim Entwerfen einer Compose API
- API-Richtlinien für
@Composable-Komponenten in Jetpack Compose:
Hier finden Sie eine Reihe von Richtlinien und Empfehlungen für die Erstellung und Verwendung von @Composable-UI-Komponenten, einschließlich der folgenden Themen:
- Komponenten erstellen und übereinanderlegen
- Neue Komponente benennen
- Komponentenabhängigkeiten angeben
- Parameter in
@Composable-Komponenten
- Befolgen Sie die richtigen Muster zum Erstellen von komponentenbezogenen Klassen und Funktionen.
@Composable-Komponenten dokumentieren- Bedienungshilfen für Komponenten verbessern
- Komponenten-APIs aktualisieren und gleichzeitig die Abwärtskompatibilität beibehalten
Zielgruppe
Diese Richtlinien richten sich an folgende drei Zielgruppen:
- Entwickler, die Apps auf Grundlage von Jetpack Compose erstellen Sie gehören zu dieser Gruppe, wenn Sie Jetpack Compose in einem Teil Ihrer App verwenden.
- Entwickler, die am Jetpack Compose-Framework arbeiten: Sie sind in dieser Gruppe, wenn Sie Beiträge zu den
androidx.compose-Bibliotheken leisten.
- Entwickler, die Bibliotheken auf Basis von Jetpack Compose erstellen Sie gehören zu dieser Gruppe, wenn Sie Compose-APIs oder Bibliotheken von Compose-UI-Elementen erstellen. Diese Bibliotheken mit Compose-Komponenten können öffentlich verfügbar oder lokal für Ihr Unternehmen oder Team sein.
Je nach Gruppe, der Sie angehören, gelten für jede Stilrichtlinie unterschiedliche Strengegrade. Die Entwicklung des Jetpack Compose-Frameworks hält sich beispielsweise in der Regel am strengsten an diese Richtlinien.
Weitere Informationen zu den Anforderungen für die einzelnen Entwicklerzielgruppen finden Sie unter RFC2119.
Beiträge zu Framework und Richtlinien leisten
Wir freuen uns über Beiträge zu ausgewählten Bibliotheken im androidx-Code und zu den Stilrichtlinien (Compose API-Richtlinien und @Composable-Komponentenrichtlinien).
Wenn Sie einen Beitrag leisten möchten, folgen Sie der Anleitung im androidx Leitfaden für Beiträge.
Alle Inhalte und Codebeispiele auf dieser Seite unterliegen den Lizenzen wie im Abschnitt Inhaltslizenz beschrieben. Java und OpenJDK sind Marken oder eingetragene Marken von Oracle und/oder seinen Tochtergesellschaften.
Zuletzt aktualisiert: 2025-09-04 (UTC).
[null,null,["Zuletzt aktualisiert: 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)."]]
