Merge pull request #993 from TopsyCretts/feat/slide-animation-direction

Added StackAnimator.inverted extension function

Author: arkivanov

extensions-compose-experimental/api/android/extensions-compose-experimental.api

@@ -99,6 +99,7 @@ public abstract interface class com/arkivanov/decompose/extensions/compose/exper
 }
 
 public final class com/arkivanov/decompose/extensions/compose/experimental/stack/animation/StackAnimatorKt {
+	public static final fun inverted (Lcom/arkivanov/decompose/extensions/compose/experimental/stack/animation/StackAnimator;)Lcom/arkivanov/decompose/extensions/compose/experimental/stack/animation/StackAnimator;
 	public static final fun plus (Lcom/arkivanov/decompose/extensions/compose/experimental/stack/animation/StackAnimator;Lcom/arkivanov/decompose/extensions/compose/experimental/stack/animation/StackAnimator;)Lcom/arkivanov/decompose/extensions/compose/experimental/stack/animation/StackAnimator;
 	public static final fun stackAnimator (Landroidx/compose/animation/core/FiniteAnimationSpec;Lkotlin/jvm/functions/Function4;)Lcom/arkivanov/decompose/extensions/compose/experimental/stack/animation/StackAnimator;
 	public static synthetic fun stackAnimator$default (Landroidx/compose/animation/core/FiniteAnimationSpec;Lkotlin/jvm/functions/Function4;ILjava/lang/Object;)Lcom/arkivanov/decompose/extensions/compose/experimental/stack/animation/StackAnimator;

extensions-compose-experimental/api/extensions-compose-experimental.klib.api

@@ -65,6 +65,7 @@ final val com.arkivanov.decompose.extensions.compose.experimental.stack.animatio
 final val com.arkivanov.decompose.extensions.compose.experimental.stack.animation/com_arkivanov_decompose_extensions_compose_experimental_stack_animation_PredictiveBackParams$stableprop // com.arkivanov.decompose.extensions.compose.experimental.stack.animation/com_arkivanov_decompose_extensions_compose_experimental_stack_animation_PredictiveBackParams$stableprop|#static{}com_arkivanov_decompose_extensions_compose_experimental_stack_animation_PredictiveBackParams$stableprop[0]
 final val com.arkivanov.decompose.extensions.compose.experimental/com_arkivanov_decompose_extensions_compose_experimental_BroadcastBackHandler$stableprop // com.arkivanov.decompose.extensions.compose.experimental/com_arkivanov_decompose_extensions_compose_experimental_BroadcastBackHandler$stableprop|#static{}com_arkivanov_decompose_extensions_compose_experimental_BroadcastBackHandler$stableprop[0]
 
+final fun (com.arkivanov.decompose.extensions.compose.experimental.stack.animation/StackAnimator).com.arkivanov.decompose.extensions.compose.experimental.stack.animation/inverted(): com.arkivanov.decompose.extensions.compose.experimental.stack.animation/StackAnimator // com.arkivanov.decompose.extensions.compose.experimental.stack.animation/inverted|inverted@com.arkivanov.decompose.extensions.compose.experimental.stack.animation.StackAnimator(){}[0]
 final fun (com.arkivanov.decompose.extensions.compose.experimental.stack.animation/StackAnimator).com.arkivanov.decompose.extensions.compose.experimental.stack.animation/plus(com.arkivanov.decompose.extensions.compose.experimental.stack.animation/StackAnimator): com.arkivanov.decompose.extensions.compose.experimental.stack.animation/StackAnimator // com.arkivanov.decompose.extensions.compose.experimental.stack.animation/plus|plus@com.arkivanov.decompose.extensions.compose.experimental.stack.animation.StackAnimator(com.arkivanov.decompose.extensions.compose.experimental.stack.animation.StackAnimator){}[0]
 final fun <#A: kotlin/Any, #B: kotlin/Any, #C: kotlin/Any, #D: kotlin/Any, #E: kotlin/Any, #F: kotlin/Any> com.arkivanov.decompose.extensions.compose.experimental.panels/ChildPanels(com.arkivanov.decompose.router.panels/ChildPanels<#A, #B, #C, #D, #E, #F>, kotlin/Function4<com.arkivanov.decompose.extensions.compose.experimental.stack.animation/StackAnimationScope, com.arkivanov.decompose/Child.Created<#A, #B>, androidx.compose.runtime/Composer, kotlin/Int, kotlin/Unit>, kotlin/Function4<com.arkivanov.decompose.extensions.compose.experimental.stack.animation/StackAnimationScope, com.arkivanov.decompose/Child.Created<#C, #D>, androidx.compose.runtime/Composer, kotlin/Int, kotlin/Unit>, kotlin/Function4<com.arkivanov.decompose.extensions.compose.experimental.stack.animation/StackAnimationScope, com.arkivanov.decompose/Child.Created<#E, #F>, androidx.compose.runtime/Composer, kotlin/Int, kotlin/Unit>, androidx.compose.ui/Modifier?, kotlin/Function3<com.arkivanov.decompose.extensions.compose.experimental.stack.animation/StackAnimationScope, androidx.compose.runtime/Composer, kotlin/Int, kotlin/Unit>?, kotlin/Function3<com.arkivanov.decompose.extensions.compose.experimental.stack.animation/StackAnimationScope, androidx.compose.runtime/Composer, kotlin/Int, kotlin/Unit>?, com.arkivanov.decompose.extensions.compose.experimental.panels/ChildPanelsLayout?, com.arkivanov.decompose.extensions.compose.experimental.panels/ChildPanelsAnimators<#A, #B, #C, #D, #E, #F>?, kotlin/Function1<com.arkivanov.decompose.router.panels/ChildPanels<#A, #B, #C, #D, #E, #F>, com.arkivanov.decompose.extensions.compose.experimental.stack.animation/PredictiveBackParams?>?, androidx.compose.runtime/Composer?, kotlin/Int, kotlin/Int) // com.arkivanov.decompose.extensions.compose.experimental.panels/ChildPanels|ChildPanels(com.arkivanov.decompose.router.panels.ChildPanels<0:0,0:1,0:2,0:3,0:4,0:5>;kotlin.Function4<com.arkivanov.decompose.extensions.compose.experimental.stack.animation.StackAnimationScope,com.arkivanov.decompose.Child.Created<0:0,0:1>,androidx.compose.runtime.Composer,kotlin.Int,kotlin.Unit>;kotlin.Function4<com.arkivanov.decompose.extensions.compose.experimental.stack.animation.StackAnimationScope,com.arkivanov.decompose.Child.Created<0:2,0:3>,androidx.compose.runtime.Composer,kotlin.Int,kotlin.Unit>;kotlin.Function4<com.arkivanov.decompose.extensions.compose.experimental.stack.animation.StackAnimationScope,com.arkivanov.decompose.Child.Created<0:4,0:5>,androidx.compose.runtime.Composer,kotlin.Int,kotlin.Unit>;androidx.compose.ui.Modifier?;kotlin.Function3<com.arkivanov.decompose.extensions.compose.experimental.stack.animation.StackAnimationScope,androidx.compose.runtime.Composer,kotlin.Int,kotlin.Unit>?;kotlin.Function3<com.arkivanov.decompose.extensions.compose.experimental.stack.animation.StackAnimationScope,androidx.compose.runtime.Composer,kotlin.Int,kotlin.Unit>?;com.arkivanov.decompose.extensions.compose.experimental.panels.ChildPanelsLayout?;com.arkivanov.decompose.extensions.compose.experimental.panels.ChildPanelsAnimators<0:0,0:1,0:2,0:3,0:4,0:5>?;kotlin.Function1<com.arkivanov.decompose.router.panels.ChildPanels<0:0,0:1,0:2,0:3,0:4,0:5>,com.arkivanov.decompose.extensions.compose.experimental.stack.animation.PredictiveBackParams?>?;androidx.compose.runtime.Composer?;kotlin.Int;kotlin.Int){0§<kotlin.Any>;1§<kotlin.Any>;2§<kotlin.Any>;3§<kotlin.Any>;4§<kotlin.Any>;5§<kotlin.Any>}[0]
 final fun <#A: kotlin/Any, #B: kotlin/Any, #C: kotlin/Any, #D: kotlin/Any, #E: kotlin/Any, #F: kotlin/Any> com.arkivanov.decompose.extensions.compose.experimental.panels/ChildPanels(com.arkivanov.decompose.value/Value<com.arkivanov.decompose.router.panels/ChildPanels<#A, #B, #C, #D, #E, #F>>, kotlin/Function4<com.arkivanov.decompose.extensions.compose.experimental.stack.animation/StackAnimationScope, com.arkivanov.decompose/Child.Created<#A, #B>, androidx.compose.runtime/Composer, kotlin/Int, kotlin/Unit>, kotlin/Function4<com.arkivanov.decompose.extensions.compose.experimental.stack.animation/StackAnimationScope, com.arkivanov.decompose/Child.Created<#C, #D>, androidx.compose.runtime/Composer, kotlin/Int, kotlin/Unit>, kotlin/Function4<com.arkivanov.decompose.extensions.compose.experimental.stack.animation/StackAnimationScope, com.arkivanov.decompose/Child.Created<#E, #F>, androidx.compose.runtime/Composer, kotlin/Int, kotlin/Unit>, androidx.compose.ui/Modifier?, kotlin/Function3<com.arkivanov.decompose.extensions.compose.experimental.stack.animation/StackAnimationScope, androidx.compose.runtime/Composer, kotlin/Int, kotlin/Unit>?, kotlin/Function3<com.arkivanov.decompose.extensions.compose.experimental.stack.animation/StackAnimationScope, androidx.compose.runtime/Composer, kotlin/Int, kotlin/Unit>?, com.arkivanov.decompose.extensions.compose.experimental.panels/ChildPanelsLayout?, com.arkivanov.decompose.extensions.compose.experimental.panels/ChildPanelsAnimators<#A, #B, #C, #D, #E, #F>?, kotlin/Function1<com.arkivanov.decompose.router.panels/ChildPanels<#A, #B, #C, #D, #E, #F>, com.arkivanov.decompose.extensions.compose.experimental.stack.animation/PredictiveBackParams?>?, androidx.compose.runtime/Composer?, kotlin/Int, kotlin/Int) // com.arkivanov.decompose.extensions.compose.experimental.panels/ChildPanels|ChildPanels(com.arkivanov.decompose.value.Value<com.arkivanov.decompose.router.panels.ChildPanels<0:0,0:1,0:2,0:3,0:4,0:5>>;kotlin.Function4<com.arkivanov.decompose.extensions.compose.experimental.stack.animation.StackAnimationScope,com.arkivanov.decompose.Child.Created<0:0,0:1>,androidx.compose.runtime.Composer,kotlin.Int,kotlin.Unit>;kotlin.Function4<com.arkivanov.decompose.extensions.compose.experimental.stack.animation.StackAnimationScope,com.arkivanov.decompose.Child.Created<0:2,0:3>,androidx.compose.runtime.Composer,kotlin.Int,kotlin.Unit>;kotlin.Function4<com.arkivanov.decompose.extensions.compose.experimental.stack.animation.StackAnimationScope,com.arkivanov.decompose.Child.Created<0:4,0:5>,androidx.compose.runtime.Composer,kotlin.Int,kotlin.Unit>;androidx.compose.ui.Modifier?;kotlin.Function3<com.arkivanov.decompose.extensions.compose.experimental.stack.animation.StackAnimationScope,androidx.compose.runtime.Composer,kotlin.Int,kotlin.Unit>?;kotlin.Function3<com.arkivanov.decompose.extensions.compose.experimental.stack.animation.StackAnimationScope,androidx.compose.runtime.Composer,kotlin.Int,kotlin.Unit>?;com.arkivanov.decompose.extensions.compose.experimental.panels.ChildPanelsLayout?;com.arkivanov.decompose.extensions.compose.experimental.panels.ChildPanelsAnimators<0:0,0:1,0:2,0:3,0:4,0:5>?;kotlin.Function1<com.arkivanov.decompose.router.panels.ChildPanels<0:0,0:1,0:2,0:3,0:4,0:5>,com.arkivanov.decompose.extensions.compose.experimental.stack.animation.PredictiveBackParams?>?;androidx.compose.runtime.Composer?;kotlin.Int;kotlin.Int){0§<kotlin.Any>;1§<kotlin.Any>;2§<kotlin.Any>;3§<kotlin.Any>;4§<kotlin.Any>;5§<kotlin.Any>}[0]

extensions-compose-experimental/api/jvm/extensions-compose-experimental.api

@@ -99,6 +99,7 @@ public abstract interface class com/arkivanov/decompose/extensions/compose/exper
 }
 
 public final class com/arkivanov/decompose/extensions/compose/experimental/stack/animation/StackAnimatorKt {
+	public static final fun inverted (Lcom/arkivanov/decompose/extensions/compose/experimental/stack/animation/StackAnimator;)Lcom/arkivanov/decompose/extensions/compose/experimental/stack/animation/StackAnimator;
 	public static final fun plus (Lcom/arkivanov/decompose/extensions/compose/experimental/stack/animation/StackAnimator;Lcom/arkivanov/decompose/extensions/compose/experimental/stack/animation/StackAnimator;)Lcom/arkivanov/decompose/extensions/compose/experimental/stack/animation/StackAnimator;
 	public static final fun stackAnimator (Landroidx/compose/animation/core/FiniteAnimationSpec;Lkotlin/jvm/functions/Function4;)Lcom/arkivanov/decompose/extensions/compose/experimental/stack/animation/StackAnimator;
 	public static synthetic fun stackAnimator$default (Landroidx/compose/animation/core/FiniteAnimationSpec;Lkotlin/jvm/functions/Function4;ILjava/lang/Object;)Lcom/arkivanov/decompose/extensions/compose/experimental/stack/animation/StackAnimator;

extensions-compose-experimental/src/commonMain/kotlin/com/arkivanov/decompose/extensions/compose/experimental/stack/animation/Slide.kt

@@ -9,6 +9,8 @@ import com.arkivanov.decompose.ExperimentalDecomposeApi
 
 /**
  * A simple sliding animation. Children enter from one side and exit to another side.
+ *
+ * You can also invert sliding direction applying [StackAnimator.inverted]
  */
 @ExperimentalDecomposeApi
 fun slide(

extensions-compose-experimental/src/commonMain/kotlin/com/arkivanov/decompose/extensions/compose/experimental/stack/animation/StackAnimator.kt

@@ -43,6 +43,27 @@ fun stackAnimator(
         frame = frame
     )
 
+/**
+ * Inverts child widgets animation direction as follows:
+ * - [Direction.ENTER_FRONT] -> [Direction.ENTER_BACK]
+ * - [Direction.EXIT_FRONT] -> [Direction.EXIT_BACK]
+ * - [Direction.ENTER_BACK] -> [Direction.ENTER_FRONT]
+ * - [Direction.EXIT_BACK] -> [Direction.EXIT_FRONT]
+ * @return the inverted [StackAnimator]
+ */
+@ExperimentalDecomposeApi
+fun StackAnimator.inverted(): StackAnimator =
+    StackAnimator { direction ->
+        animate(
+            direction = when (direction) {
+                Direction.ENTER_FRONT -> Direction.ENTER_BACK
+                Direction.EXIT_FRONT -> Direction.EXIT_BACK
+                Direction.ENTER_BACK -> Direction.ENTER_FRONT
+                Direction.EXIT_BACK -> Direction.EXIT_FRONT
+            },
+        )
+    }
+
 /**
  * Combines (merges) the receiver [StackAnimator] with the [other] [StackAnimator].
  */