Jetpack Compose API のスタイル ガイドライン

アプリの Compose コードを作成する場合や、Compose ライブラリと API をビルドする場合は、ベスト プラクティスに沿って、コードのスケーラビリティとパフォーマンスを高め、エコシステムの他の部分との一貫性を保つようにしてください。

Compose を使用するコードを作成するすべてのユーザー向けのガイドラインについては、次のドキュメントをご覧ください。

  • Jetpack Compose の API ガイドライン: Jetpack Compose コンパイラ プラグインとランタイムを使用するすべてのシステム向けのパターン、ベスト プラクティス、規範的なスタイル ガイドラインの概要を示します。次のトピックが含まれています。
  • Jetpack Compose の @Composable コンポーネントの API ガイドライン: @Composable UI コンポーネントの作成と使用に関する一連のガイドラインと推奨事項を提供します。次のトピックが含まれています。
    • コンポーネントの作成とレイヤリング
    • 新しいコンポーネントの名前付け
    • コンポーネントの依存関係の表現
    • @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 貢献 ガイドの手順に沿って行ってください。