Merge pull request #22 from canopas/add-restart-intro-support

Add restart intro support
canopas · Jan 3, 2024 · 1245bde · 1245bde
2 parents 3e0bdf6 + 368d5bc
commit 1245bde
Show file tree

Hide file tree

Showing 3 changed files with 30 additions and 5 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,7 +48,9 @@ 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.IntroShowcaseState
 import com.canopas.lib.showcase.component.ShowcaseStyle
+import com.canopas.lib.showcase.component.rememberIntroShowcaseState
 
 class MainActivity : ComponentActivity() {
     override fun onCreate(savedInstanceState: Bundle?) {
@@ -75,13 +77,16 @@ fun ShowcaseSample() {
         mutableStateOf(true)
     }
 
+    val introShowcaseState = rememberIntroShowcaseState()
+
     IntroShowcase(
         showIntroShowCase = showAppIntro,
         dismissOnClickOutside = false,
         onShowCaseCompleted = {
             //App Intro finished!!
             showAppIntro = false
         },
+        state = introShowcaseState,
     ) {
         Scaffold(
             modifier = Modifier.fillMaxSize(),
@@ -91,7 +96,7 @@ fun ShowcaseSample() {
                     backgroundColor = Color.Transparent,
                     elevation = 0.dp,
                     navigationIcon = {
-                        BackButton()
+                        BackButton(introShowcaseState)
                     },
                     actions = {
                         IconButton(
@@ -191,7 +196,7 @@ fun IntroShowcaseScope.FloatingMailButton() {
 }
 
 @Composable
-fun IntroShowcaseScope.BackButton() {
+fun IntroShowcaseScope.BackButton(introShowcaseState: IntroShowcaseState) {
     IconButton(
         onClick = {},
         modifier = Modifier.introShowCaseTarget(
@@ -222,6 +227,15 @@ fun IntroShowcaseScope.BackButton() {
                             color = Color.White,
                             fontSize = 16.sp
                         )
+
+                        Button(
+                            onClick = {
+                                // Used to restart the intro showcase
+                                introShowcaseState.reset()
+                            },
+                        ) {
+                            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/...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,15 +47,26 @@ 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?
         get() = targets[currentTargetIndex]
+
+    /**
+     * Resets the state to its initial values, effectively restarting the showcase.
+     */
+    fun reset() {
+        currentTargetIndex = 0
+    }
 }