アプリの 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 投稿ガイドの手順に沿って操作します。