navigationevent

navigationevent

  

API リファレンス
androidx.navigationevent

Navigation Event ライブラリには、システムの「戻る」と予測型「戻る」を処理するための KMP ファーストの API が用意されています。

最新の更新	安定版リリース	リリース候補版	ベータ版リリース	アルファ版リリース
2025 年 6 月 18 日	-	-	-	1.0.0-alpha03

依存関係の宣言

navigationevent への依存関係を追加するには、Google の Maven リポジトリをプロジェクトに追加する必要があります。詳しくは、Google の Maven リポジトリをご覧ください。

アプリまたはモジュールの build.gradle ファイルに、必要なアーティファクトの依存関係を追加します。

Groovy

dependencies {
    implementation "androidx.navigationevent:navigationevent:1.0.0-alpha03"
}

Kotlin

dependencies {
    implementation("androidx.navigationevent:navigationevent:1.0.0-alpha03")
}

依存関係について詳しくは、ビルド依存関係の追加をご覧ください。

フィードバック

お寄せいただいたフィードバックは Jetpack 改善の参考にさせていただきます。新しい問題が見つかった場合や、このライブラリを改善するアイデアをお持ちの場合は、お知らせください。新しい問題を報告していただく前に、このライブラリの既存の問題をご確認ください。スターボタンをクリックすると、既存の問題に投票できます。

新しい問題を報告する

詳細については、Issue Tracker のドキュメントをご覧ください。

このアーティファクトのリリースノートはありません。

バージョン 1.0

バージョン 1.0.0-alpha03

2025 年 6 月 18 日

androidx.navigationevent:navigationevent-*:1.0.0-alpha03 がリリースされました。バージョン 1.0.0-alpha03 には、これらの commit が含まれています。

新機能

• navigationevent ライブラリで Jetpack Compose 機能をサポートする新しい navigationevent-compose モジュールを導入しました。（980d78）
• NavigationEvent Compose に新しい LocalNavigationEventDispatcherOwner ローカル コンポジションが追加されました。現在の合成中に使用可能かどうかを判断しやすくするための null 許容値を返します。NavigationEventHandler は、基になるオーナーが見つからない場合にエラーをスローするようになりました。（62ffda）
• NavigationEvent Compose に、（予測型「戻る」ジェスチャー）イベントを処理する新しい NavigationEventHandler コンポーザブルが追加されました。指定した suspend ラムダ c42ba6 で収集する必要がある NavigationEvent オブジェクトの Flow を提供します。

NavigationEventHandler { progress: Flow<NavigationEvent> ->
  // This block is executed when the back gesture begins.
  try {
    progress.collect { backEvent ->
      // Handle gesture progress updates here.
    }
    // This block is executed if the gesture completes successfully.
  } catch (e: CancellationException) {
    // This block is executed if the gesture is cancelled
    throw e
  } finally {
    // This block is executed either the gesture is completed or cancelled
  }
}

API の変更

• 各 NavigationEventCallback を一度に登録できる NavigationEventDispatcher は 1 つだけになりました。複数のディスパッチャに追加すると、IllegalStateException がスローされます。この動作は、複数のディスパッチャを許可する OnBackPressedDispatcher とは異なります。（e82c19）
• isPassThrough を val に変更し、ナビゲーション中のミューテーションを防ぎ、NavigationEvent のディスパッチを中断しないようにしました。（I0b287）

バージョン 1.0.0-alpha02

2025 年 6 月 4 日

androidx.navigationevent:navigationevent-*:1.0.0-alpha02 がリリースされました。バージョン 1.0.0-alpha02 には、これらの commit が含まれています。

API の変更

• NavigationEventDispatcher のセカンダリ コンストラクタをデフォルトの引数に置き換えます。（I716a0）
• NavigationEventCallback から優先度プロパティを削除しました。代わりに、優先度を NavigationEventDispatcher.addCallback() に渡します。（I13cae）

バグの修正

• NavigationEventCallback.remove() が呼び出されたときに、closeable の内部リストが同時に変更されたために発生する可能性があった ConcurrentModificationException を修正しました。（b/420919815）

バージョン 1.0.0-alpha01

2025 年 5 月 20 日

androidx.navigationevent:navigationevent-*:1.0.0-alpha01 がリリースされました。バージョン 1.0.0-alpha01 には、これらの commit が含まれています。

新機能

• androidx.navigationevent ライブラリは、システムの「戻る」と予測型「戻る」を処理するための KMP ファーストの API を提供します。NavigationEventDispatcher は、システムの [戻る] イベントを受信する 1 つ以上の NavigationEventCallback インスタンスを登録するための共通 API として機能します。
• このレイヤは、以前にリリースされた androidx.activity の API の下位に位置し、上位レベルのコンポーネントで Activity API を使用するか、Android フレームワークの OnBackInvokedDispatcher API を直接使用する代わりに、より柔軟に使用できる API を目指しています。androidx.activity API は、Activity 1.12.0-alpha01 の一部として、Navigation Event API の上に書き直されました。