review: Add safeCurrentContent() kDoc

Infomaniak · Nov 7, 2024 · b1ae78c · b1ae78c
1 parent 884368f
commit b1ae78c
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/app/src/main/java/com/infomaniak/swisstransfer/ui/components/TwoPaneScaffold.kt b/app/src/main/java/com/infomaniak/swisstransfer/ui/components/TwoPaneScaffold.kt
@@ -77,6 +77,10 @@ fun <T> TwoPaneScaffold(
     )
 }
 
+/**
+ * Keep the DetailPane's content in memory so that it's always available while navigating back.
+ * When leaving the DetailPane, its content becomes `null`, which creates a visual glitch in the back animation.
+ */
 @OptIn(ExperimentalMaterial3AdaptiveApi::class)
 @Composable
 fun <T> ThreePaneScaffoldNavigator<T>.safeCurrentContent(): T? {