アプリの 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 のコントリビューション ガイドの手順に沿って操作してください。