Add restart intro support

canopas · Jan 3, 2024 · ede4ef1 · ede4ef1
1 parent 3e0bdf6
commit ede4ef1
Show file tree

Hide file tree

Showing 6 changed files with 59 additions and 3 deletions.
diff --git a/app/src/main/java/com/canopas/campose/showcase/MainActivity.kt b/app/src/main/java/com/canopas/campose/showcase/MainActivity.kt
@@ -48,6 +48,7 @@ import com.canopas.campose.showcase.ui.theme.JetTapTargetTheme
 import com.canopas.campose.showcase.ui.theme.ThemeColor
 import com.canopas.lib.showcase.IntroShowcase
 import com.canopas.lib.showcase.IntroShowcaseScope
+import com.canopas.lib.showcase.component.IntroShowcaseManager
 import com.canopas.lib.showcase.component.ShowcaseStyle
 
 class MainActivity : ComponentActivity() {
@@ -222,6 +223,14 @@ fun IntroShowcaseScope.BackButton() {
                             color = Color.White,
                             fontSize = 16.sp
                         )
+
+                        Button(
+                            onClick = {
+                                IntroShowcaseManager.introRestartHandler?.invoke()
+                            },
+                        ) {
+                            Text(text = "Restart Intro")
+                        }
                     }
                 }
             },

diff --git a/docs/index.md b/docs/index.md
@@ -30,7 +30,7 @@ fun ShowcaseSample() {
         mutableStateOf(true)
     }
 
-    IntroShowCase(
+    IntroShowcase(
         showIntroShowCase = showAppIntro,
         dismissOnClickOutside = false,
         onShowCaseCompleted = {

diff --git a/showcase/src/main/java/com/canopas/lib/showcase/IntroShowcase.kt b/showcase/src/main/java/com/canopas/lib/showcase/IntroShowcase.kt
@@ -2,8 +2,10 @@ package com.canopas.lib.showcase
 
 import androidx.compose.foundation.layout.BoxScope
 import androidx.compose.runtime.Composable
+import androidx.compose.runtime.DisposableEffect
 import androidx.compose.runtime.remember
 import androidx.compose.ui.Modifier
+import com.canopas.lib.showcase.component.IntroShowcaseManager
 import com.canopas.lib.showcase.component.IntroShowcaseState
 import com.canopas.lib.showcase.component.ShowcasePopup
 import com.canopas.lib.showcase.component.ShowcaseStyle
@@ -22,6 +24,15 @@ fun IntroShowcase(
         IntroShowcaseScope(state)
     }
 
+    DisposableEffect(Unit) {
+        IntroShowcaseManager.registerRestoreHandler {
+            state.currentTargetIndex = 0
+        }
+        onDispose {
+            IntroShowcaseManager.registerRestoreHandler(null)
+        }
+    }
+
     scope.content()
 
     if (showIntroShowCase) {

diff --git a/showcase/src/main/java/com/canopas/lib/showcase/component/IntroShowcaseManager.kt b/showcase/src/main/java/com/canopas/lib/showcase/component/IntroShowcaseManager.kt
@@ -0,0 +1,24 @@
+package com.canopas.lib.showcase.component
+
+import com.canopas.lib.showcase.handler.IntroRestartHandler
+
+/**
+ * Manager class for IntroShowcase. Manages the registration and invocation of
+ * [IntroRestartHandler] callbacks.
+ */
+object IntroShowcaseManager {
+    /**
+     * A nullable [IntroRestartHandler] that holds a callback function to be invoked when restarting
+     * IntroShowcase. It allows external components to register custom logic to execute when
+     * restarting the IntroShowcase, providing flexibility for handling restart events.
+     */
+    var introRestartHandler: IntroRestartHandler? = null
+
+    /**
+     * Register a [IntroRestartHandler] callback to be invoked when restarting the IntroShowcase.
+     */
+    @JvmStatic
+    internal fun registerRestoreHandler(introRestartHandler: IntroRestartHandler?) {
+        this.introRestartHandler = introRestartHandler
+    }
+}
diff --git a/...s/lib/showcase/component/ShowCasestate.kt → .../showcase/component/IntroShowcaseState.kt b/...s/lib/showcase/component/ShowCasestate.kt → .../showcase/component/IntroShowcaseState.kt
@@ -3,8 +3,8 @@ package com.canopas.lib.showcase.component
 import androidx.compose.foundation.layout.BoxScope
 import androidx.compose.runtime.Composable
 import androidx.compose.runtime.getValue
+import androidx.compose.runtime.mutableIntStateOf
 import androidx.compose.runtime.mutableStateMapOf
-import androidx.compose.runtime.mutableStateOf
 import androidx.compose.runtime.remember
 import androidx.compose.runtime.setValue
 import androidx.compose.ui.Modifier
@@ -47,13 +47,17 @@ internal fun Modifier.introShowcaseTarget(
     )
 }
 
+/**
+ * State class for managing the state of the IntroShowcase. Tracks the current target index and
+ * associated targets.
+ */
 class IntroShowcaseState internal constructor(
     initialIndex: Int,
 ) {
 
     internal var targets = mutableStateMapOf<Int, IntroShowcaseTargets>()
 
-    var currentTargetIndex by mutableStateOf(initialIndex)
+    var currentTargetIndex by mutableIntStateOf(initialIndex)
         internal set
 
     val currentTarget: IntroShowcaseTargets?

diff --git a/showcase/src/main/java/com/canopas/lib/showcase/handler/IntroRestartHandler.kt b/showcase/src/main/java/com/canopas/lib/showcase/handler/IntroRestartHandler.kt
@@ -0,0 +1,8 @@
+package com.canopas.lib.showcase.handler
+
+/**
+ * Interface for handling restart callbacks in IntroShowcase.
+ */
+fun interface IntroRestartHandler {
+    operator fun invoke()
+}