Added discardSavedState argument to SavedStateRegistryOwner#stateKeep…

…er extension function
arkivanov · Nov 30, 2023 · cd5244c · cd5244c
1 parent f68fe2f
commit cd5244c
Showing 1 changed file with 6 additions and 1 deletion.
diff --git a/state-keeper/src/androidMain/kotlin/com/arkivanov/essenty/statekeeper/AndroidExt.kt b/state-keeper/src/androidMain/kotlin/com/arkivanov/essenty/statekeeper/AndroidExt.kt
@@ -43,10 +43,15 @@ fun StateKeeper(
 /**
  * Creates a new instance of [StateKeeper] and attaches it to the AndroidX [SavedStateRegistry].
  *
+ * @param discardSavedState a flag indicating whether any previously saved state should be discarded or not,
+ * default value is `false`.
  * @param isSavingAllowed called before saving the state.
  * When `true` then the state will be saved, otherwise it won't. Default value is `true`.
  */
-fun SavedStateRegistryOwner.stateKeeper(isSavingAllowed: () -> Boolean = { true }): StateKeeper =
+fun SavedStateRegistryOwner.stateKeeper(
+ discardSavedState: Boolean = false,
+ isSavingAllowed: () -> Boolean = { true },
+): StateKeeper =
  StateKeeper(
  savedStateRegistry = savedStateRegistry,
  isSavingAllowed = isSavingAllowed