アプリ用の 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 貢献ガイドの手順に沿って操作してください。