アプリの Compose コードを記述する場合や、Compose ライブラリと API をビルドする場合は、ベスト プラクティスに沿ってコードをスケーラブルにし、パフォーマンスを向上させ、エコシステムの他の部分と整合性を持たせます。
次のドキュメントでは、Compose を使用するコードを記述するすべてのユーザー向けのガイドラインを示します。
- Jetpack Compose の API ガイドライン: Jetpack Compose コンパイラ プラグインとランタイムを使用するシステムのパターン、ベスト プラクティス、規範的なスタイル ガイドラインの概要を説明します。次のトピックが含まれます。
- Kotlin コーディング規則に基づく Compose の Kotlin スタイルガイド
- Compose ランタイム機能に基づいて構築された
@Composable関数と API のガイダンス - Compose UI ツールキットを使用して拡張する API のガイドライン
- Compose API を設計する際のユースケースに対応するパターン
- Jetpack Compose の
@Composableコンポーネントの API ガイドライン:@ComposableUI コンポーネントの作成と使用に関する一連のガイドラインと推奨事項が記載されています。次のトピックが含まれます。- コンポーネントの作成とレイヤリング
- 新しいコンポーネントに名前を付ける
- コンポーネントの依存関係を表現する
@Composableコンポーネントのパラメータ- コンポーネント関連のクラスと関数を作成する正しいパターンに従う
@Composableコンポーネントのドキュメント化- コンポーネントのユーザー補助の改善
- 下位互換性を維持しながらコンポーネント API を更新する
対象読者
このガイドラインは、次の 3 つの対象読者を想定して作成されています。
- Jetpack Compose に基づいてアプリを構築するデベロッパー。アプリの一部で Jetpack Compose を使用している場合は、このグループに該当します。
- Jetpack Compose フレームワークの開発に携わるデベロッパー。
androidx.composeライブラリに貢献している場合は、このグループに属します。 - Jetpack Compose に基づいてライブラリを作成するデベロッパー。Compose API または Compose UI 要素のライブラリを作成する場合は、このグループに該当します。これらの Compose コンポーネントのライブラリは、一般公開されているものもあれば、会社やチームにローカルなものもあります。
所属するグループに応じて、スタイル ガイドラインごとに厳格さのレベルが異なります。たとえば、Jetpack Compose フレームワークの開発では、通常、これらのガイドラインに厳密に準拠しています。
各デベロッパー オーディエンスの要件の詳細については、RFC2119 をご覧ください。
フレームワークとガイドラインに貢献する
androidx コードベースの一部のライブラリとスタイル ガイドライン（Compose API ガイドラインと @Composable コンポーネント ガイドライン）への貢献を歓迎します。
貢献するには、androidx 貢献ガイドの手順に沿って操作します。