review related updates

adrielcafe · May 24, 2024 · 683bd46 · 683bd46
1 parent 2a68388
commit 683bd46
Show file tree

Hide file tree

Showing 12 changed files with 188 additions and 149 deletions.
diff --git a/docs/transitions-api.md b/docs/transitions-api.md
@@ -80,20 +80,31 @@ setContent {
 
 If you want to define a Enter and Exit transition for a specific Screen, you have a lot of options to do
 starting from 1.1.0-beta01 Voyager have a new experimental API for this purpose.
+To animate the content, we use transitions of the target screen in the case of push navigation, otherwise we use transitions of the initial screen 
 
 ```kotlin
-class ExampleScaleScreen : Screen, ScreenTransition {
+class ExampleSlideScreen : Screen, ScreenTransition {
     override val key: ScreenKey
         get() = uniqueScreenKey
 
     @Composable
     override fun Content() {
         ...
     }
-
-    override fun enter(): EnterTransition? = scaleIn()
 
-    override fun exit(): ExitTransition? = scaleOut()
+    override fun enter(lastEvent: StackEvent): EnterTransition {
+        return slideIn { size ->
+            val x = if (lastEvent == StackEvent.Pop) -size.width else size.width
+            IntOffset(x = x, y = 0)
+        }
+    }
+
+    override fun exit(lastEvent: StackEvent): ExitTransition {
+        return slideOut { size ->
+            val x = if (lastEvent == StackEvent.Pop) size.width else -size.width
+            IntOffset(x = x, y = 0)
+        }
+    }
 }
 ```
 

diff --git a/samples/android/src/main/java/cafe/adriel/voyager/sample/SampleActivity.kt b/samples/android/src/main/java/cafe/adriel/voyager/sample/SampleActivity.kt
@@ -67,7 +67,7 @@ class SampleActivity : ComponentActivity() {
                 StartSampleButton<LiveDataIntegrationActivity>("LiveData Integration")
                 StartSampleButton<HiltMainActivity>("Hilt Integration")
                 StartSampleButton<LegacyActivity>("Legacy Integration")
-                StartSampleButton<ScreenTransitionActivity>("ScreenTransitionActivity")
+                StartSampleButton<ScreenTransitionActivity>("Screen Transition")
             }
         }
     }

diff --git a/...les/android/src/main/java/cafe/adriel/voyager/sample/screenTransition/BaseSampleScreen.kt b/...les/android/src/main/java/cafe/adriel/voyager/sample/screenTransition/BaseSampleScreen.kt
diff --git a/samples/android/src/main/java/cafe/adriel/voyager/sample/screenTransition/FadeTransition.kt b/samples/android/src/main/java/cafe/adriel/voyager/sample/screenTransition/FadeTransition.kt
diff --git a/samples/android/src/main/java/cafe/adriel/voyager/sample/screenTransition/SampleScreen.kt b/samples/android/src/main/java/cafe/adriel/voyager/sample/screenTransition/SampleScreen.kt
diff --git a/samples/android/src/main/java/cafe/adriel/voyager/sample/screenTransition/SampleScreens.kt b/samples/android/src/main/java/cafe/adriel/voyager/sample/screenTransition/SampleScreens.kt
@@ -0,0 +1,68 @@
+package cafe.adriel.voyager.sample.screenTransition
+
+import androidx.compose.foundation.background
+import androidx.compose.foundation.layout.Arrangement
+import androidx.compose.foundation.layout.Column
+import androidx.compose.foundation.layout.Spacer
+import androidx.compose.foundation.layout.fillMaxSize
+import androidx.compose.foundation.layout.height
+import androidx.compose.foundation.layout.padding
+import androidx.compose.material.Text
+import androidx.compose.runtime.Composable
+import androidx.compose.ui.Alignment
+import androidx.compose.ui.Modifier
+import androidx.compose.ui.graphics.Color
+import androidx.compose.ui.text.font.FontWeight
+import androidx.compose.ui.unit.dp
+import androidx.compose.ui.unit.sp
+import cafe.adriel.voyager.core.screen.Screen
+import cafe.adriel.voyager.core.screen.ScreenKey
+import cafe.adriel.voyager.transitions.ScreenTransition
+
+private val colors = listOf(
+    Color.Red,
+    Color.Yellow,
+    Color.Green,
+    Color.Blue,
+    Color.Black
+)
+
+abstract class BaseSampleScreen(
+    private val transitionType: String
+) : Screen {
+
+    abstract val index: Int
+
+    override val key: ScreenKey get() = "SampleScreen$index"
+
+    @Composable
+    override fun Content() {
+        Column(
+            modifier = Modifier
+                .fillMaxSize()
+                .background(colors[index % colors.size].copy(alpha = 0.3f))
+                .padding(40.dp),
+            verticalArrangement = Arrangement.Center,
+            horizontalAlignment = Alignment.CenterHorizontally
+        ) {
+            Text(
+                text = "Screen $index",
+                fontSize = 24.sp,
+                fontWeight = FontWeight.Bold
+            )
+            Spacer(modifier = Modifier.height(8.dp))
+            Text(
+                text = transitionType,
+                fontSize = 18.sp
+            )
+        }
+    }
+}
+
+data class NoCustomAnimationSampleScreen(
+    override val index: Int
+) : BaseSampleScreen("Default transition")
+
+data class FadeAnimationSampleScreen(
+    override val index: Int
+) : BaseSampleScreen("Fade transition"), ScreenTransition by FadeTransition()
diff --git a/...es/android/src/main/java/cafe/adriel/voyager/sample/screenTransition/SampleTransitions.kt b/...es/android/src/main/java/cafe/adriel/voyager/sample/screenTransition/SampleTransitions.kt
@@ -0,0 +1,40 @@
+package cafe.adriel.voyager.sample.screenTransition
+
+import androidx.compose.animation.EnterTransition
+import androidx.compose.animation.ExitTransition
+import androidx.compose.animation.core.tween
+import androidx.compose.animation.fadeIn
+import androidx.compose.animation.fadeOut
+import androidx.compose.animation.slideIn
+import androidx.compose.animation.slideOut
+import androidx.compose.ui.unit.IntOffset
+import cafe.adriel.voyager.core.stack.StackEvent
+import cafe.adriel.voyager.transitions.ScreenTransition
+
+class FadeTransition : ScreenTransition {
+
+    override fun enter(lastEvent: StackEvent): EnterTransition {
+        return fadeIn(tween(500, delayMillis = 500))
+    }
+
+    override fun exit(lastEvent: StackEvent): ExitTransition {
+        return fadeOut(tween(500))
+    }
+}
+
+class SlideTransition : ScreenTransition {
+
+    override fun enter(lastEvent: StackEvent): EnterTransition {
+        return slideIn { size ->
+            val x = if (lastEvent == StackEvent.Pop) -size.width else size.width
+            IntOffset(x = x, y = 0)
+        }
+    }
+
+    override fun exit(lastEvent: StackEvent): ExitTransition {
+        return slideOut { size ->
+            val x = if (lastEvent == StackEvent.Pop) size.width else -size.width
+            IntOffset(x = x, y = 0)
+        }
+    }
+}
diff --git a/...oid/src/main/java/cafe/adriel/voyager/sample/screenTransition/ScreenTransitionActivity.kt b/...oid/src/main/java/cafe/adriel/voyager/sample/screenTransition/ScreenTransitionActivity.kt
@@ -3,7 +3,18 @@ package cafe.adriel.voyager.sample.screenTransition
 import android.os.Bundle
 import androidx.activity.ComponentActivity
 import androidx.activity.compose.setContent
+import androidx.compose.foundation.layout.Arrangement
+import androidx.compose.foundation.layout.Box
+import androidx.compose.foundation.layout.Row
+import androidx.compose.foundation.layout.fillMaxSize
+import androidx.compose.foundation.layout.fillMaxWidth
+import androidx.compose.foundation.layout.padding
+import androidx.compose.material.Button
+import androidx.compose.material.Text
 import androidx.compose.runtime.Composable
+import androidx.compose.ui.Alignment
+import androidx.compose.ui.Modifier
+import androidx.compose.ui.unit.dp
 import cafe.adriel.voyager.navigator.Navigator
 import cafe.adriel.voyager.transitions.ScreenTransition
 
@@ -21,11 +32,42 @@ class ScreenTransitionActivity : ComponentActivity() {
     fun Content() {
         Navigator(
             screen = NoCustomAnimationSampleScreen(0)
-        ) {
-            ScreenTransition(
-                navigator = it,
-                defaultTransition = SlideTransition()
-            )
+        ) { navigator ->
+            Box(modifier = Modifier.fillMaxSize()) {
+                ScreenTransition(
+                    navigator = navigator,
+                    defaultTransition = SlideTransition()
+                )
+
+                Row(
+                    modifier = Modifier
+                        .align(Alignment.BottomCenter)
+                        .fillMaxWidth()
+                        .padding(40.dp),
+                    horizontalArrangement = Arrangement.spacedBy(20.dp)
+                ) {
+                    Button(
+                        onClick = { navigator.push(FadeAnimationSampleScreen(navigator.items.size)) },
+                        modifier = Modifier.weight(1f)
+                    ) {
+                        Text(text = "Fade")
+                    }
+
+                    Button(
+                        onClick = { navigator.push(NoCustomAnimationSampleScreen(navigator.items.size)) },
+                        modifier = Modifier.weight(1f)
+                    ) {
+                        Text(text = "Default")
+                    }
+
+                    Button(
+                        onClick = { navigator.pop() },
+                        modifier = Modifier.weight(1f)
+                    ) {
+                        Text(text = "Pop")
+                    }
+                }
+            }
         }
     }
 }
diff --git a/samples/android/src/main/java/cafe/adriel/voyager/sample/screenTransition/SlideTransition.kt b/samples/android/src/main/java/cafe/adriel/voyager/sample/screenTransition/SlideTransition.kt
diff --git a/voyager-transitions/api/android/voyager-transitions.api b/voyager-transitions/api/android/voyager-transitions.api
@@ -50,12 +50,11 @@ public final class cafe/adriel/voyager/transitions/ScaleTransitionKt {
 }
 
 public final class cafe/adriel/voyager/transitions/ScreenTransition$DefaultImpls {
-	public static fun enter (Lcafe/adriel/voyager/transitions/ScreenTransition;Z)Landroidx/compose/animation/EnterTransition;
-	public static fun exit (Lcafe/adriel/voyager/transitions/ScreenTransition;Z)Landroidx/compose/animation/ExitTransition;
+	public static fun enter (Lcafe/adriel/voyager/transitions/ScreenTransition;Lcafe/adriel/voyager/core/stack/StackEvent;)Landroidx/compose/animation/EnterTransition;
+	public static fun exit (Lcafe/adriel/voyager/transitions/ScreenTransition;Lcafe/adriel/voyager/core/stack/StackEvent;)Landroidx/compose/animation/ExitTransition;
 }
 
 public final class cafe/adriel/voyager/transitions/ScreenTransitionKt {
-	public static final fun ScreenTransition (Lcafe/adriel/voyager/navigator/Navigator;Lcafe/adriel/voyager/transitions/ScreenTransition;Landroidx/compose/ui/Modifier;Lkotlin/jvm/functions/Function4;Landroidx/compose/runtime/Composer;II)V
 	public static final fun ScreenTransition (Lcafe/adriel/voyager/navigator/Navigator;Lkotlin/jvm/functions/Function1;Landroidx/compose/ui/Modifier;Lkotlin/jvm/functions/Function4;Landroidx/compose/runtime/Composer;II)V
 	public static final fun ScreenTransition (Lcafe/adriel/voyager/navigator/Navigator;Lkotlin/jvm/functions/Function1;Lkotlin/jvm/functions/Function1;Landroidx/compose/ui/Modifier;Lkotlin/jvm/functions/Function4;Landroidx/compose/runtime/Composer;II)V
 }

diff --git a/voyager-transitions/api/desktop/voyager-transitions.api b/voyager-transitions/api/desktop/voyager-transitions.api
@@ -50,12 +50,11 @@ public final class cafe/adriel/voyager/transitions/ScaleTransitionKt {
 }
 
 public final class cafe/adriel/voyager/transitions/ScreenTransition$DefaultImpls {
-	public static fun enter (Lcafe/adriel/voyager/transitions/ScreenTransition;Z)Landroidx/compose/animation/EnterTransition;
-	public static fun exit (Lcafe/adriel/voyager/transitions/ScreenTransition;Z)Landroidx/compose/animation/ExitTransition;
+	public static fun enter (Lcafe/adriel/voyager/transitions/ScreenTransition;Lcafe/adriel/voyager/core/stack/StackEvent;)Landroidx/compose/animation/EnterTransition;
+	public static fun exit (Lcafe/adriel/voyager/transitions/ScreenTransition;Lcafe/adriel/voyager/core/stack/StackEvent;)Landroidx/compose/animation/ExitTransition;
 }
 
 public final class cafe/adriel/voyager/transitions/ScreenTransitionKt {
-	public static final fun ScreenTransition (Lcafe/adriel/voyager/navigator/Navigator;Lcafe/adriel/voyager/transitions/ScreenTransition;Landroidx/compose/ui/Modifier;Lkotlin/jvm/functions/Function4;Landroidx/compose/runtime/Composer;II)V
 	public static final fun ScreenTransition (Lcafe/adriel/voyager/navigator/Navigator;Lkotlin/jvm/functions/Function1;Landroidx/compose/ui/Modifier;Lkotlin/jvm/functions/Function4;Landroidx/compose/runtime/Composer;II)V
 	public static final fun ScreenTransition (Lcafe/adriel/voyager/navigator/Navigator;Lkotlin/jvm/functions/Function1;Lkotlin/jvm/functions/Function1;Landroidx/compose/ui/Modifier;Lkotlin/jvm/functions/Function4;Landroidx/compose/runtime/Composer;II)V
 }