From f4e49876ac3fad90376323fa23b6991581d547c7 Mon Sep 17 00:00:00 2001
From: Tram Bui <62119967+trambui09@users.noreply.github.com>
Date: Thu, 21 Nov 2024 13:27:59 -0800
Subject: [PATCH] add in predictive back snippets for NavHost and predictive
 back handler (#394)

* add in predictive back snippets

* Apply Spotless

* add in basic predictivebackhandler composable example

* Apply Spotless

---------

Co-authored-by: trambui09 <trambui09@users.noreply.github.com>
---
 .../predictiveback/PredictiveBackSnippets.kt  | 190 ++++++++++++++++++
 1 file changed, 190 insertions(+)
 create mode 100644 compose/snippets/src/main/java/com/example/compose/snippets/predictiveback/PredictiveBackSnippets.kt

diff --git a/compose/snippets/src/main/java/com/example/compose/snippets/predictiveback/PredictiveBackSnippets.kt b/compose/snippets/src/main/java/com/example/compose/snippets/predictiveback/PredictiveBackSnippets.kt
new file mode 100644
index 00000000..88ec5c4a
--- /dev/null
+++ b/compose/snippets/src/main/java/com/example/compose/snippets/predictiveback/PredictiveBackSnippets.kt
@@ -0,0 +1,190 @@
+/*
+ * Copyright 2024 The Android Open Source Project
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.example.compose.snippets.predictiveback
+
+import android.os.SystemClock
+import androidx.activity.BackEventCompat
+import androidx.activity.compose.PredictiveBackHandler
+import androidx.compose.animation.EnterTransition
+import androidx.compose.animation.core.Animatable
+import androidx.compose.animation.scaleOut
+import androidx.compose.foundation.background
+import androidx.compose.foundation.layout.Box
+import androidx.compose.foundation.layout.fillMaxSize
+import androidx.compose.material3.Surface
+import androidx.compose.runtime.Composable
+import androidx.compose.runtime.getValue
+import androidx.compose.runtime.mutableFloatStateOf
+import androidx.compose.runtime.mutableStateOf
+import androidx.compose.runtime.remember
+import androidx.compose.runtime.rememberCoroutineScope
+import androidx.compose.runtime.setValue
+import androidx.compose.ui.Modifier
+import androidx.compose.ui.geometry.Offset
+import androidx.compose.ui.graphics.Color
+import androidx.compose.ui.graphics.TransformOrigin
+import androidx.compose.ui.input.pointer.util.VelocityTracker
+import androidx.compose.ui.platform.LocalDensity
+import androidx.compose.ui.unit.dp
+import androidx.navigation.NavHostController
+import androidx.navigation.compose.NavHost
+import androidx.navigation.compose.composable
+import androidx.navigation.compose.rememberNavController
+import kotlin.coroutines.cancellation.CancellationException
+import kotlinx.coroutines.flow.Flow
+
+@Composable
+private fun PredictiveBackOverrideExit(
+    modifier: Modifier,
+) {
+    val navController = rememberNavController()
+
+    // [START android_compose_predictiveback_navhost]
+    NavHost(
+        navController = navController,
+        startDestination = "home",
+        popExitTransition = {
+            scaleOut(
+                targetScale = 0.9f,
+                transformOrigin = TransformOrigin(pivotFractionX = 0.5f, pivotFractionY = 0.5f)
+            )
+        },
+        popEnterTransition = {
+            EnterTransition.None
+        },
+        modifier = modifier,
+    )
+    // [END android_compose_predictiveback_navhost]
+    {
+        composable("home") {
+            HomeScreen(
+                modifier = modifier,
+                navController = navController,
+            )
+        }
+        composable("settings") {
+            SettingsScreen(
+                modifier = modifier,
+                navController = navController,
+            )
+        }
+    }
+}
+
+@Composable
+private fun HomeScreen(
+    modifier: Modifier = Modifier,
+    navController: NavHostController
+) {
+}
+
+@Composable
+private fun SettingsScreen(
+    modifier: Modifier = Modifier,
+    navController: NavHostController
+) {
+}
+
+@Composable
+private fun PredictiveBackHandlerBasicExample() {
+
+    var boxScale by remember { mutableFloatStateOf(1F) }
+
+    Box(
+        modifier = Modifier
+            .fillMaxSize(boxScale)
+            .background(Color.Blue)
+    )
+
+    // [START android_compose_predictivebackhandler_basic]
+    PredictiveBackHandler(true) { progress: Flow<BackEventCompat> ->
+        // code for gesture back started
+        try {
+            progress.collect { backEvent ->
+                // code for progress
+                boxScale = 1F - (1F * backEvent.progress)
+            }
+            // code for completion
+        } catch (e: CancellationException) {
+            // code for cancellation
+            boxScale = 1F
+        }
+    }
+    // [END android_compose_predictivebackhandler_basic]
+}
+
+@Composable
+private fun PredictiveBackHandlerManualProgress() {
+
+    Surface(
+        modifier = Modifier.fillMaxSize()
+    ) {
+        var drawerState by remember {
+            mutableStateOf(DrawerState.Closed)
+        }
+
+        val translationX = remember {
+            Animatable(0f)
+        }
+
+        val drawerWidth = with(LocalDensity.current) {
+            DrawerWidth.toPx()
+        }
+        translationX.updateBounds(0f, drawerWidth)
+
+        val coroutineScope = rememberCoroutineScope()
+
+        suspend fun closeDrawer(velocity: Float = 0f) {
+            translationX.animateTo(targetValue = 0f, initialVelocity = velocity)
+            drawerState = DrawerState.Closed
+        }
+        suspend fun openDrawer(velocity: Float = 0f) {
+            translationX.animateTo(targetValue = drawerWidth, initialVelocity = velocity)
+            drawerState = DrawerState.Open
+        }
+
+        val velocityTracker = remember {
+            VelocityTracker()
+        }
+
+        // [START android_compose_predictivebackhandler_manualprogress]
+        PredictiveBackHandler(drawerState == DrawerState.Open) { progress ->
+            try {
+                progress.collect { backEvent ->
+                    val targetSize = (drawerWidth - (drawerWidth * backEvent.progress))
+                    translationX.snapTo(targetSize)
+                    velocityTracker.addPosition(
+                        SystemClock.uptimeMillis(),
+                        Offset(backEvent.touchX, backEvent.touchY)
+                    )
+                }
+                closeDrawer(velocityTracker.calculateVelocity().x)
+            } catch (e: CancellationException) {
+                openDrawer(velocityTracker.calculateVelocity().x)
+            }
+            velocityTracker.resetTracking()
+        }
+        // [END android_compose_predictivebackhandler_manualprogress]
+    }
+}
+
+private enum class DrawerState {
+    Open,
+    Closed
+}
+
+private val DrawerWidth = 300.dp