「戻る」ジェスチャーと予測型「戻る」アニメーションを処理する

抽象クラス NavigationEventHandler を拡張して、プラットフォーム間のナビゲーション イベントを処理できます。このクラスは、ナビゲーション ジェスチャーのライフサイクルに対応するメソッドを提供します。

val myHandler = object: NavigationEventHandler<NavigationEventInfo>(
    initialInfo = NavigationEventInfo.None,
    isBackEnabled = true
) {
    override fun onBackStarted(event: NavigationEvent) {
        // Prepare for the back event
    }

    override fun onBackProgressed(event: NavigationEvent) {
        // Use event.progress for predictive animations
    }

    // This is the required method for final event handling
    override fun onBackCompleted() {
        // Complete the back event
    }

    override fun onBackCancelled() {
        // Cancel the back event
    }
}
NavEventSnippets.kt

addHandler 関数は、ハンドラをディスパッチャに接続します。

navigationEventDispatcher.addHandler(myHandler)
NavEventSnippets.kt

myHandler.remove() を呼び出して、ディスパッチャからハンドラを削除します。

myHandler.remove()
NavEventSnippets.kt

ハンドラは、優先度と新しさに基づいて呼び出されます。すべての PRIORITY_OVERLAY ハンドラは、PRIORITY_DEFAULT ハンドラよりも前に呼び出されます。各優先順位グループ内では、ハンドラは後入れ先出し（LIFO）の順序で呼び出されます。つまり、最後に追加されたハンドラが最初に呼び出されます。

Jetpack Compose で戻る操作をインターセプトする

Jetpack Compose の場合、このライブラリにはディスパッチャ階層を管理するためのユーティリティ コンポーザブルが用意されています。

NavigationBackHandler コンポーザブルは、コンテンツの NavigationEventHandler を作成し、それを LocalNavigationEventDispatcherOwner にリンクします。Compose の DisposableEffect を使用して、コンポーザブルが画面から離れるときにディスパッチャーの dispose() メソッドを自動的に呼び出し、リソースを安全に管理します。

@Composable
public fun NavigationBackHandler(
    state: NavigationEventState<out NavigationEventInfo>,
    isBackEnabled: Boolean = true,
    onBackCancelled: () -> Unit = {},
    onBackCompleted: () -> Unit,
){

}
NavEventSnippets.kt

この関数を使用すると、ローカライズされた UI サブツリー内でイベント処理を正確に制御できます。

@Composable
fun HandlingBackWithTransitionState(
    onNavigateUp: () -> Unit
) {
    val navigationState = rememberNavigationEventState(
        currentInfo = NavigationEventInfo.None
    )
    val transitionState = navigationState.transitionState
    // React to predictive back transition updates
    when (transitionState) {
        is NavigationEventTransitionState.InProgress -> {
            val progress = transitionState.latestEvent.progress
            // Use progress (0f..1f) to update UI during the gesture
        }
        is NavigationEventTransitionState.Idle -> {
            // Reset any temporary UI state if the gesture is cancelled
        }
    }
    NavigationBackHandler(
        state = navigationState,
        onBackCancelled = {
            // Called if the back gesture is cancelled
        },
        onBackCompleted = {
            // Called when the back gesture fully completes
            onNavigateUp()
        }
    )
}
NavEventSnippets.kt

この例では、NavigationEventTransitionState を使用して予測型「戻る」ジェスチャーの更新を監視する方法を示します。progress の値を使用して、戻るジェスチャーに応じて UI 要素を更新できます。また、NavigationBackHandler を通じて完了とキャンセルを処理できます。

Compose で「戻る」操作またはエッジスワイプにアクセスする

図 1. NavigationEvent と Compose で作成された予測型「戻る」アニメーション。

ユーザーがスワイプして戻る際に画面をアニメーション表示するには、（a）NavigationEventTransitionState が InProgress かどうかを確認し、（b）rememberNavigationEventState で進行状況とスワイプ エッジの状態を監視する必要があります。

  • progress: ユーザーがスワイプした距離を示す 0.0 から 1.0 までの浮動小数点数。
  • swipeEdge: ジェスチャーが開始された位置を示す整数定数（EDGE_LEFT または EDGE_RIGHT）。

次のスニペットは、スケールとシフトのアニメーションを実装する方法の簡略化された例です。

object Routes {
    const val SCREEN_A = "Screen A"
    const val SCREEN_B = "Screen B"
}

class MainActivity : ComponentActivity() {
    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContent {
            var state by remember { mutableStateOf(Routes.SCREEN_A) }
            val backEventState = rememberNavigationEventState<NavigationEventInfo>(currentInfo = NavigationEventInfo.None)
            when (state) {
                Routes.SCREEN_A -> {
                    ScreenA(onNavigate = { state = Routes.SCREEN_B })
                }
                else -> {
                    if (backEventState.transitionState is NavigationEventTransitionState.InProgress) {
                        ScreenA(onNavigate = { })
                    }
                    ScreenB(
                        backEventState = backEventState,
                        onBackCompleted = { state = Routes.SCREEN_A }
                    )
                }
            }
        }
    }
}

@Composable
fun ScreenB(
    backEventState: NavigationEventState<NavigationEventInfo>,
    onBackCompleted: () -> Unit = {},
) {
    val transitionState = backEventState.transitionState
    val latestEvent =
        (transitionState as? NavigationEventTransitionState.InProgress)
            ?.latestEvent
    val backProgress = latestEvent?.progress ?: 0f
    val swipeEdge = latestEvent?.swipeEdge ?: NavigationEvent.EDGE_LEFT
    if (transitionState is NavigationEventTransitionState.InProgress) {
        Log.d("BackGesture", "Progress: ${transitionState.latestEvent.progress}")
    } else if (transitionState is NavigationEventTransitionState.Idle) {
        Log.d("BackGesture", "Idle")
    }
    val animatedScale by animateFloatAsState(
        targetValue = 1f - (backProgress * 0.1f),
        label = "ScaleAnimation"
    )
    val windowInfo = LocalWindowInfo.current
    val density = LocalDensity.current
    val maxShift = remember(windowInfo, density) {
        val widthDp = with(density) { windowInfo.containerSize.width.toDp() }
        (widthDp.value / 20f) - 8
    }
    val offsetX = when (swipeEdge) {
        EDGE_LEFT -> (backProgress * maxShift).dp
        EDGE_RIGHT -> (-backProgress * maxShift).dp
        else -> 0.dp
    }
    NavigationBackHandler(
        state = backEventState,
        onBackCompleted = onBackCompleted,
        isBackEnabled = true
    )
    Box(
        modifier = Modifier
            .offset(x = offsetX)
            .scale(animatedScale)
    ){
        // Rest of UI
    }
}
NavEventSnippets.kt

前へ
Set up development environment
次へ
Set up a dispatcher