fix: reset overlay content when Reveal composable is disposed (#197)

svenjacobs · web-flow · commit 8acfdec2246b · 2025-01-19T15:53:12.000+01:00
diff --git a/reveal-core/src/commonMain/kotlin/com/svenjacobs/reveal/Reveal.kt b/reveal-core/src/commonMain/kotlin/com/svenjacobs/reveal/Reveal.kt
@@ -5,6 +5,7 @@ import androidx.compose.foundation.gestures.detectTapGestures
 import androidx.compose.foundation.layout.Box
 import androidx.compose.foundation.layout.fillMaxSize
 import androidx.compose.runtime.Composable
+import androidx.compose.runtime.DisposableEffect
 import androidx.compose.runtime.LaunchedEffect
 import androidx.compose.runtime.derivedStateOf
 import androidx.compose.runtime.getValue
@@ -158,6 +159,14 @@ public fun Reveal(
 			}
 		}
 	}
+
+	// When the Reveal composable is disposed we need to reset overlayContent or else the effect
+	// might remain on the screen (issue #196).
+	DisposableEffect(Unit) {
+		onDispose {
+			revealCanvasState.overlayContent = null
+		}
+	}
 }
 
 public typealias OnClickListener = (key: Key) -> Unit

Original file line number	Diff line number	Diff line change
`@@ -5,6 +5,7 @@ import androidx.compose.foundation.gestures.detectTapGestures`
`5`	`5`	`import androidx.compose.foundation.layout.Box`
`6`	`6`	`import androidx.compose.foundation.layout.fillMaxSize`
`7`	`7`	`import androidx.compose.runtime.Composable`
	`8`	`+import androidx.compose.runtime.DisposableEffect`
`8`	`9`	`import androidx.compose.runtime.LaunchedEffect`
`9`	`10`	`import androidx.compose.runtime.derivedStateOf`
`10`	`11`	`import androidx.compose.runtime.getValue`
`@@ -158,6 +159,14 @@ public fun Reveal(`
`158`	`159`	`}`
`159`	`160`	`}`
`160`	`161`	`}`
	`162`	`+`
	`163`	`+ // When the Reveal composable is disposed we need to reset overlayContent or else the effect`
	`164`	`+ // might remain on the screen (issue #196).`
	`165`	`+ DisposableEffect(Unit) {`
	`166`	`+ onDispose {`
	`167`	`+ revealCanvasState.overlayContent = null`
	`168`	`+ }`
	`169`	`+ }`
`161`	`170`	`}`
`162`	`171`
`163`	`172`	`public typealias OnClickListener = (key: Key) -> Unit`