Wear OS 向け Compose での Navigation


Android Jetpack の Navigation コンポーネントは、Jetpack Compose アプリをサポートしています。Navigation コンポーネントのインフラストラクチャと機能を活用しながら、コンポーザブル間を移動できます。

このページでは、Wear OS 向け Compose の Jetpack Navigation との違いについて説明します。

設定

アプリ モジュールの build.gradle ファイルで次の依存関係を使用します。

Kotlin

dependencies {
    def wear_compose_version = "1.7.2"
    implementation "androidx.wear.compose:compose-navigation:$wear_compose_version"
}

これは、Wear OS 固有の代替実装を実現するため、androidx.navigation:navigation-compose アーティファクトの代わりに使用されます。

ナビゲーション コントローラ、ホスト、グラフを作成する

Wear OS 向け Compose を使用して移動するには、Wear OS 以外のアプリに必要な 3 つのコンポーネント(ナビゲーション コントローラ、ホスト、グラフ)が必要です。

rememberSwipeDismissableNavController() を使用して WearNavigator のインスタンスを作成します。これは、Wear OS アプリに適した NavController の実装です。

val navController = rememberSwipeDismissableNavController()

NavController は、Compose アプリでナビゲーションに使用される主要な API です。Wear OS では SwipeDismissableNavHost であるナビゲーション ホスト内のコンポーザブル間の移動を制御します。

val navController = rememberSwipeDismissableNavController()
SwipeDismissableNavHost(
    navController = navController,
    startDestination = "message_list"
) {
    // TODO: build navigation graph
}

NavHost コンポーザブルと同様に、ナビゲーション コントローラ、開始デスティネーションのルート、ここでは後置ラムダとして表示されるナビゲーション グラフのビルダーへの参照を受け取ります。

開始デスティネーションは、ナビゲーション コントローラを使用して移動する必要がある他のすべてのデスティネーションとともに、ナビゲーション グラフのビルダーで指定する必要があります。

Wear OS アプリで、SwipeDismissableNavHost を AppScaffold のコンテンツとして宣言し、時間、スクロールまたは位置インジケーター、ページ インジケーターなどの最上位コンポーネントをサポートします。 画面レベルで SwipeDismissableNavHost と ScreenScaffold の上に AppScaffold オブジェクトを使用して、デフォルトで TimeText オブジェクトを画面に追加し、画面間を移動するときに正しくアニメーション化されるようにします。また、ScreenScaffold はスクロール可能なコンテンツの PositionIndicator を追加します。
    AppScaffold {
        val navController = rememberSwipeDismissableNavController()
        SwipeDismissableNavHost(
            navController = navController,
            startDestination = "message_list"
        ) {
            composable("message_list") {
                MessageList(onMessageClick = { id ->
                    navController.navigate("message_detail/$id")
                })
            }
            composable("message_detail/{id}") {
                MessageDetail(id = it.arguments?.getString("id")!!)
            }
        }
    }
}

// Implementation of one of the screens in the navigation
@Composable
fun MessageDetail(id: String) {
    // .. Screen level content goes here
    val scrollState = rememberTransformingLazyColumnState()
    val transformationSpec = rememberTransformationSpec()

    ScreenScaffold(
        scrollState = scrollState,
    ) { contentPadding ->
        // Screen content goes here
        // ...

ダイアログを表示する

Wear OS 向け Compose でマテリアル 3 を使用してダイアログ(AlertDialog、ConfirmationDialog、OpenOnPhoneDialog、Dialog など)を表示するには、ダイアログを開く画面コンポーザブルのデスティネーション内で直接ダイアログ コンポーザブルを宣言します。手順は次のとおりです。

  1. ブール値の状態変数を使用してダイアログの表示を制御し、その状態をダイアログの visible パラメータに渡します。rememberSaveable または ViewModel にホイスティングされた状態を使用します。
  2. onDismissRequest コールバックと、その他の確認または拒否アクションのコールバックで、状態変数を false に設定します。これにより、ユーザーがスワイプして閉じるか、アクションを選択すると、ダイアログがアニメーションで消えて、元の画面に戻ります。

詳細については、AlertDialog、ConfirmationDialog、OpenOnPhoneDialog の API リファレンス ドキュメントをご覧ください。

Jetpack Navigation の詳細については、Compose を使用したナビゲーションを参照するか、Jetpack Compose のナビゲーションの Codelab を受講してください。